Skip to content

clustermesh: add MCS-API user docs #35114

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 1, 2024
Merged

clustermesh: add MCS-API user docs #35114

merged 1 commit into from
Oct 1, 2024

Conversation

MrFreezeex
Copy link
Member

Please ensure your pull request adheres to the following guidelines:

  • For first time contributors, read Submitting a pull request
  • All code is covered by unit and/or runtime tests where feasible.
  • All commits contain a well written commit description including a title,
    description and a Fixes: #XXX line if the commit addresses a particular
    GitHub issue.
  • If your commit description contains a Fixes: <commit-id> tag, then
    please add the commit author[s] as reviewer[s] to this issue.
  • All commits are signed off. See the section Developer’s Certificate of Origin
  • Provide a title or release-note blurb suitable for the release notes.
  • Are you a user of Cilium? Please add yourself to the Users doc
  • Thanks for contributing!

Add MCS-API docs and rework a bit the clustermesh example deployment to update nginx and make both clustermesh examples have some common deployment manifests.

Add documentation for clustermesh MCS-API support

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Sep 30, 2024
MrFreezeex
MrFreezeex commented Sep 30, 2024
View reviewed changes
@MrFreezeex MrFreezeex force-pushed the mcsapi-docs branch 2 times, most recently from 5c7d572 to bc73177 Compare September 30, 2024 13:07
@MrFreezeex MrFreezeex marked this pull request as ready for review September 30, 2024 13:12
@MrFreezeex MrFreezeex requested review from a team as code owners September 30, 2024 13:12
@MrFreezeex MrFreezeex requested review from giorio94 and a user September 30, 2024 13:12
giorio94
giorio94 approved these changes Oct 1, 2024
View reviewed changes
Copy link
Member

@giorio94 giorio94 left a comment

Choose a reason for hiding this comment

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

Thanks, the content looks great to me. I've left a bunch of nits inline, mostly about the rendering of the links and code blocks. To easily double-check the result, you can launch a preview server locally with make -C Documentation live-preview.

@giorio94 giorio94 added area/clustermesh Relates to multi-cluster routing functionality in Cilium. release-note/misc This PR makes changes that have no direct user impact. labels Oct 1, 2024
@maintainer-s-little-helper maintainer-s-little-helper bot removed dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Oct 1, 2024
@MrFreezeex
clustermesh: add MCS-API user docs
ea37a7f 
Add MCS-API docs and rework a bit the clustermesh example deployment to
update nginx and make both clustermesh examples have some common
deployment manifests.

Signed-off-by: Arthur Outhenin-Chalandre <arthur@cri.epita.fr>
@ghost ghost added the area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. label Oct 1, 2024
@ghost
Copy link

ghost commented Oct 1, 2024

/test

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Oct 1, 2024
@julianwiedmann julianwiedmann added this pull request to the merge queue Oct 1, 2024
Merged via the queue into cilium:main with commit 252d768 Oct 1, 2024
63 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@giorio94 giorio94 giorio94 approved these changes

+1 more reviewer
Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
area/clustermesh Relates to multi-cluster routing functionality in Cilium. area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@MrFreezeex @giorio94 @julianwiedmann