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.

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

docs: Add user manual how to enable and configure multicast feature. #32612

Merged
merged 1 commit into from
May 31, 2024
Merged

docs: Add user manual how to enable and configure multicast feature. #32612

merged 1 commit into from
May 31, 2024

Conversation

fujitatomoya
Copy link
Contributor

@fujitatomoya fujitatomoya commented May 17, 2024 •
edited

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!

Fixes: #28750

related references:

@fujitatomoya fujitatomoya requested a review from a team as a code owner May 17, 2024 20:55
@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 May 17, 2024
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label May 17, 2024
fujitatomoya
fujitatomoya commented May 17, 2024
View reviewed changes
Documentation/network/multicast.rst Show resolved Hide resolved
Documentation/network/multicast.rst Outdated Show resolved Hide resolved
Documentation/network/multicast.rst Show resolved Hide resolved
@fujitatomoya fujitatomoya mentioned this pull request May 17, 2024
Closed
@lambdanis lambdanis added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. labels May 21, 2024
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label May 21, 2024
@lambdanis lambdanis requested a review from ldelossa May 21, 2024 17:05
lambdanis
lambdanis requested changes May 21, 2024
View reviewed changes
Copy link
Contributor

@lambdanis lambdanis left a comment

Choose a reason for hiding this comment

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

Thank you @fujitatomoya!

I left several style suggestions, but the main request is to add "(Beta)" to the page header.

We should also add the new doc to the CODEOWNERS file. I guess sig-datapath would be a good codeowner, is that right @ldelossa? Then the CODEOWNERS file should include:

/Documentation/network/multicast.rst @cilium/sig-datapath @cilium/docs-structure

(the entries are listed alphabetically). Can you add it @fujitatomoya?

Documentation/network/multicast.rst Show resolved Hide resolved
Documentation/network/multicast.rst Outdated Show resolved Hide resolved
Documentation/network/multicast.rst Outdated Show resolved Hide resolved
Documentation/network/multicast.rst Outdated Show resolved Hide resolved
Documentation/network/multicast.rst Outdated Show resolved Hide resolved
Documentation/network/multicast.rst Outdated Show resolved Hide resolved
Documentation/network/multicast.rst Outdated Show resolved Hide resolved
Documentation/network/multicast.rst Outdated Show resolved Hide resolved
Documentation/network/multicast.rst Outdated Show resolved Hide resolved
Documentation/network/multicast.rst Outdated Show resolved Hide resolved
@fujitatomoya fujitatomoya requested a review from a team as a code owner May 22, 2024 20:03
@fujitatomoya fujitatomoya force-pushed the doc/initial-multicast-support branch 3 times, most recently from 33c571b to 8f8007c Compare May 22, 2024 20:11
@fujitatomoya
Copy link
Contributor Author

@lambdanis all comments are addressed, and rebasing is done. ready to 2nd review, thanks!

lambdanis
lambdanis requested changes May 24, 2024
View reviewed changes
Copy link
Contributor

@lambdanis lambdanis left a comment

Choose a reason for hiding this comment

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

One more request, otherwise looks good, thanks @fujitatomoya!

Could you also squash the commits into one?

Documentation/network/multicast.rst Outdated Show resolved Hide resolved
@fujitatomoya fujitatomoya force-pushed the doc/initial-multicast-support branch from 975822a to 12286bb Compare May 26, 2024 19:13
@fujitatomoya
Copy link
Contributor Author

@lambdanis thanks, addressed prerequisites header and squash all commits into one.

@fujitatomoya fujitatomoya force-pushed the doc/initial-multicast-support branch from 12286bb to 7d1f40e Compare May 26, 2024 19:16
lambdanis
lambdanis approved these changes May 27, 2024
View reviewed changes
Copy link
Contributor

@lambdanis lambdanis left a comment

Choose a reason for hiding this comment

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

looks good to me, thanks!

bimmlerd
bimmlerd approved these changes May 28, 2024
View reviewed changes
Copy link
Member

@bimmlerd bimmlerd left a comment

Choose a reason for hiding this comment

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

CODEOWNERS lgtm

@lambdanis
Copy link
Contributor

/test

@ldelossa
Copy link
Contributor

@lambdanis yes your suggestion about codeowner looks good.

ldelossa
ldelossa approved these changes May 29, 2024
View reviewed changes
Copy link
Contributor

@ldelossa ldelossa left a comment

Choose a reason for hiding this comment

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

Just some wording issues, but overall looks good.

Documentation/network/multicast.rst Outdated Show resolved Hide resolved
harsimran-pabla
harsimran-pabla approved these changes May 29, 2024
View reviewed changes
Copy link
Contributor

@harsimran-pabla harsimran-pabla left a comment

Choose a reason for hiding this comment

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

nit change, otherwise looks good to me.

Documentation/network/multicast.rst Outdated Show resolved Hide resolved
@fujitatomoya fujitatomoya force-pushed the doc/initial-multicast-support branch from 7d1f40e to 01c22d3 Compare May 29, 2024 18:49
@fujitatomoya
docs: Add user manual how to enable and configure multicast feature.
5e5403c 
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
@fujitatomoya fujitatomoya force-pushed the doc/initial-multicast-support branch from 01c22d3 to 5e5403c Compare May 29, 2024 18:51
@lambdanis
Copy link
Contributor

/test

@yushoyamaguchi yushoyamaguchi mentioned this pull request May 30, 2024
Closed
@aanm aanm enabled auto-merge May 31, 2024 10:31
@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 May 31, 2024
@aanm aanm added this pull request to the merge queue May 31, 2024
Merged via the queue into cilium:main with commit a7f2084 May 31, 2024
63 of 64 checks passed
@yushoyamaguchi yushoyamaguchi mentioned this pull request Jun 1, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lambdanis lambdanis lambdanis approved these changes

@ldelossa ldelossa ldelossa approved these changes

@bimmlerd bimmlerd bimmlerd approved these changes

@harsimran-pabla harsimran-pabla harsimran-pabla approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/multicast kind/community-contribution This was a contribution made by a community member. 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.

CFP: multicast support
6 participants
@fujitatomoya @lambdanis @ldelossa @bimmlerd @harsimran-pabla @aanm