DOCS: CE-661 Refactor CNI plugin content #23707
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tgross
reviewed
Jul 31, 2024
There was a problem hiding this comment.
This looks great @aimeeu!
One meta-comment on formatting. We've always hard-wrapped documentation in the Nomad repository because it makes it easier to review changes. If the documentation teams want to standardize on non-hard-wrapped markdown across the org, I suppose we'll need to go along with that. But if not, it'd be nice to stay consistent with the rest of the repo. That'll keep PR diffs a little more reasonably sized as well.
tunzor
requested changes
Jul 31, 2024
Co-authored-by: Anthony <[email protected]>
aimeeu
changed the title
boruszak
reviewed
Jul 31, 2024
There was a problem hiding this comment.
Great work!
I reviewed for style, focusing on the partials.
Also, to format deployment preview links so that they use a stable branch that automatically updates after each new Vercel deployment, format the URL as <repo>-git-<branch-name>-hashicorp.vercel.app. For this PR, it's https://nomad-git-docs-ce661-hashicorp.vercel.app/
Co-authored-by: Jeff Boruszak <[email protected]>
aimeeu
changed the title
Co-authored-by: Jeff Boruszak <[email protected]>
boruszak
approved these changes
Aug 5, 2024
|
|
||
| This configuration uses the following CNI reference plugins: | ||
|
|
||
| - loopback: The loopback plugin sets the default local interface, lo0, created |
There was a problem hiding this comment.
This is the only list item without a link to the plugin
There was a problem hiding this comment.
@boruszak there is no documentation for the loopback plugin. It never had docs - I went back several release. The plugin was deprecated in 2019, but it is still distributed as part of the CNI plugins release.
tgross
added
backport/1.6.x
|
I've added a couple of |
This was referenced Aug 6, 2024
Co-authored-by: Jeff Boruszak <[email protected]>
tunzor
approved these changes
Aug 6, 2024
tgross
pushed a commit
that referenced
this pull request
Aug 6, 2024
- Pulled common content from multiple pages into new partials - Refactored install/index to be OS-based so I could add linux-distro-based instructions to install-consul-cni-plugins.mdx partial. The tab groups on the install/index page do match and change focus as expected. - Moved CNI overview-type content to networking/index - Refactored networking/cni to include install CNI plugins and configuration content (from install/index). - Moved CNI plugins explanation in bridge mode configuration section into bullet points. They had been #### headings, which aren't rendered in the R page TOC. I tried to simplify and format the bullet point content to be easier to scan. Ref: https://hashicorp.atlassian.net/browse/CE-661 Fixes: #23229 Fixes: #23583
tgross
pushed a commit
that referenced
this pull request
Aug 6, 2024
- Pulled common content from multiple pages into new partials - Refactored install/index to be OS-based so I could add linux-distro-based instructions to install-consul-cni-plugins.mdx partial. The tab groups on the install/index page do match and change focus as expected. - Moved CNI overview-type content to networking/index - Refactored networking/cni to include install CNI plugins and configuration content (from install/index). - Moved CNI plugins explanation in bridge mode configuration section into bullet points. They had been #### headings, which aren't rendered in the R page TOC. I tried to simplify and format the bullet point content to be easier to scan. Ref: https://hashicorp.atlassian.net/browse/CE-661 Fixes: #23229 Fixes: #23583
tgross
pushed a commit
that referenced
this pull request
Aug 6, 2024
- Pulled common content from multiple pages into new partials - Refactored install/index to be OS-based so I could add linux-distro-based instructions to install-consul-cni-plugins.mdx partial. The tab groups on the install/index page do match and change focus as expected. - Moved CNI overview-type content to networking/index - Refactored networking/cni to include install CNI plugins and configuration content (from install/index). - Moved CNI plugins explanation in bridge mode configuration section into bullet points. They had been #### headings, which aren't rendered in the R page TOC. I tried to simplify and format the bullet point content to be easier to scan. Ref: https://hashicorp.atlassian.net/browse/CE-661 Fixes: #23229 Fixes: #23583
tgross
added a commit
that referenced
this pull request
Aug 6, 2024
) - Pulled common content from multiple pages into new partials - Refactored install/index to be OS-based so I could add linux-distro-based instructions to install-consul-cni-plugins.mdx partial. The tab groups on the install/index page do match and change focus as expected. - Moved CNI overview-type content to networking/index - Refactored networking/cni to include install CNI plugins and configuration content (from install/index). - Moved CNI plugins explanation in bridge mode configuration section into bullet points. They had been #### headings, which aren't rendered in the R page TOC. I tried to simplify and format the bullet point content to be easier to scan. Ref: https://hashicorp.atlassian.net/browse/CE-661 Fixes: #23229 Fixes: #23583 Co-authored-by: Aimee Ukasick <[email protected]>
tgross
added a commit
that referenced
this pull request
Aug 6, 2024
) - Pulled common content from multiple pages into new partials - Refactored install/index to be OS-based so I could add linux-distro-based instructions to install-consul-cni-plugins.mdx partial. The tab groups on the install/index page do match and change focus as expected. - Moved CNI overview-type content to networking/index - Refactored networking/cni to include install CNI plugins and configuration content (from install/index). - Moved CNI plugins explanation in bridge mode configuration section into bullet points. They had been #### headings, which aren't rendered in the R page TOC. I tried to simplify and format the bullet point content to be easier to scan. Ref: https://hashicorp.atlassian.net/browse/CE-661 Fixes: #23229 Fixes: #23583 Co-authored-by: Aimee Ukasick <[email protected]>
tgross
pushed a commit
that referenced
this pull request
Aug 6, 2024
- Pulled common content from multiple pages into new partials - Refactored install/index to be OS-based so I could add linux-distro-based instructions to install-consul-cni-plugins.mdx partial. The tab groups on the install/index page do match and change focus as expected. - Moved CNI overview-type content to networking/index - Refactored networking/cni to include install CNI plugins and configuration content (from install/index). - Moved CNI plugins explanation in bridge mode configuration section into bullet points. They had been #### headings, which aren't rendered in the R page TOC. I tried to simplify and format the bullet point content to be easier to scan. Ref: https://hashicorp.atlassian.net/browse/CE-661 Fixes: #23229 Fixes: #23583 Co-authored-by: Aimee Ukasick <[email protected]>
|
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Jira: CE-661
Deploy previews:
Fixes: #23229
Fixes: #23583