fix code and note blocks in dualtor pages #1649
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
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
aaaaaaaalex
force-pushed
the
dual-tor-improvements
branch
from
32eef56
to
5312cb5
Compare
ctauchen
reviewed
Sep 12, 2024
| @@ -475,6 +473,7 @@ startup prior to receiving BGPPeer and BGPConfiguration resources from the datas | |||
| EarlyNetworkingConfiguration will be superseded by any BGPPeer or BGPConfiguration | |||
| resources after successful startup. | |||
|
|
|||
| For a full description of the EarlyNetworkingConfiguration resource, see [here](../../reference/resources/earlynetworkconfiguration.mdx) | |||
There was a problem hiding this comment.
Suggested change
| For a full description of the EarlyNetworkingConfiguration resource, see [here](../../reference/resources/earlynetworkconfiguration.mdx) | |
| For a full description, see [Early Network Configuration](../../reference/resources/earlynetworkconfiguration.mdx) |
There was a problem hiding this comment.
What's the difference between EarlyNetworkingConfiguration (line 473) and EarlyNetworkConfiguration?
There was a problem hiding this comment.
EarlyNetworkingConfiguration doesn't exist - typo!
| Early network configuration will be superseded by any BGPPeer or BGPConfiguration | ||
| resources after successful startup. | ||
|
|
||
| For a detailed guide on how to set up dual ToR, see [here](../../networking/configuring/dual-tor.mdx). |
There was a problem hiding this comment.
Suggested change
| For a detailed guide on how to set up dual ToR, see [here](../../networking/configuring/dual-tor.mdx). | |
| For a detailed guide on how to set up dual ToR, see [Deploy a dual ToR cluster](../../networking/configuring/dual-tor.mdx). |
There was a problem hiding this comment.
Always good practice to have specific anchors.
Comment on lines
15
to
18
| :::note | ||
| Early network configurations are intended for use only when {{prodname}} is being run in "early networking" mode, i.e. when operating a "dual ToR" networking configuration. If you are not running a dual-plane cluster, this is probably not what you are looking for! | ||
| For configuring BGP networking under normal circumstances (when {{prodname}} is running), see [BGPConfiguration](bgpconfig.mdx), [BGPPeer](bgppeer.mdx), and [BGPFilter](bgpfilter.mdx). | ||
| ::: |
There was a problem hiding this comment.
Consider moving this information into the top paragraph. If it's really only for dual-tor, you can say that in the first description.
| ### ConfigStableAddress | ||
| | Field | Description | Accepted Values | Schema Default | | ||
| | ------------------------------------- | --------------------------------------------------------------- | ----------------- | -------------- | | ||
| | address | IP address which {{prodname}} should provision during earlynetworking as the "stable" address | IP Address string | "" | |
There was a problem hiding this comment.
during earlynetworking --> during early networking
If that's the established wording. Sounds a bit funny to my ear.
| | Field | Description | Accepted Values | Schema Default | | ||
| | ------------ | --------------------------------------------------------------------------------------------------------- | ----------------- | -------------- | | ||
| | peerIP | The IP address of the ToR | IP Address string | "" | | ||
| | peerASNumber | The AS number of the ToR. When left as 0, {{prodname}} early-networking will use its own node's AS number | integer | 0 | |
|
Feedback is all implemented now, reviewdog is finding English typos within YAML, safe to ignore. |
|
LGTM, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Product Version(s):
mdx syntax bugfix applies to all versions.
New documentation applies only to 3.20EP2 and later.
Issue:
PMREQ-629
Link to docs preview:
SME review:
DOCS review:
Additional information:
Merge checklist: