Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Topology-aware routing docs #1920

Merged
merged 12 commits into from
Feb 26, 2025
Merged

Topology-aware routing docs #1920

merged 12 commits into from
Feb 26, 2025

Conversation

kflynn
Copy link
Member

@kflynn kflynn commented Feb 3, 2025

Originally from @deusxanima in #1579, thanks! 🙂

  • Adding feature documentation and task instructions for topology aware hints
  • cleaned up previously committed errors and modified phrasing as recommended by Flynn.
  • fixed minor typo
  • fixed missing code block notation on Hints.ForZones
  • Tweaks plus callouts for stable features in 2.16+

@kflynn kflynn requested a review from alpeb February 3, 2025 02:39
@kflynn
Copy link
Member Author

kflynn commented Feb 3, 2025

Forced DCO because Alen was a Buoyant employee when he wrote this...

@travisbeckham
Copy link
Collaborator

This is super nitpicky, but when we did the site rebuild, we switched all frontmatter to yaml. Prior to that, it was a mix of toml and yaml. I'll let you decide if we want to keep this consistent.

@kflynn
Copy link
Member Author

kflynn commented Feb 3, 2025

Nice catch! I didn't notice that at all.

Copy link
Collaborator

@travisbeckham travisbeckham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some minor comments on the 2.17 docs, which would also apply to all other versions.

@kflynn kflynn force-pushed the deusxanima-1579 branch 2 times, most recently from ebaa891 to 0683261 Compare February 25, 2025 17:34
@kflynn kflynn changed the title Topology-aware hinting docs Topology-aware routing docs Feb 26, 2025
Copy link
Member

@alpeb alpeb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@kflynn kflynn merged commit cba6df5 into main Feb 26, 2025
7 checks passed
@kflynn kflynn deleted the deusxanima-1579 branch February 26, 2025 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants