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: fix typos and formatting #25365

Merged
merged 1 commit into from May 24, 2023
Merged

docs: fix typos and formatting #25365

merged 1 commit into from May 24, 2023

Conversation

peterj
Copy link
Contributor

@peterj peterj commented May 10, 2023

fix typos and formatting in the docs.

@peterj peterj requested review from a team as code owners May 10, 2023 17:15
@peterj peterj requested review from qmonnet and youngnick May 10, 2023 17:15
@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 10, 2023
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label May 10, 2023
@peterj
Copy link
Contributor Author

peterj commented May 10, 2023

@jibi / @qmonnet sorry for re-creating the PR -- I got into a git mess, and it was cleaner to do it so. I incorporated all feedback.

@qmonnet
Copy link
Member

qmonnet commented May 10, 2023

Could you please amend your commit to fix the description (you have the description of three different commits in it)? You may drop the Co-authored-by: tag here; if you prefer to keep it, I'd appreciate if you could use my work email (quentin@isovalent.com) rather than personal one that GitHub uses by default.

As far as I understand, GitHub is having internal issues that would explain most of the CI errors we observe.

The Netlify errors are not related to GitHub though:

6:16:37 PM: /opt/build/repo/Documentation/network/kubernetes/kubeproxy-free.rst:73: WARNING: Explicit markup ends without a blank line; unexpected unindent.
6:16:37 PM: /opt/build/repo/Documentation/network/kubernetes/kubeproxy-free.rst:94: WARNING: Literal block ends without a blank line; unexpected unindent.

Can you please look into this?

qmonnet
qmonnet requested changes May 10, 2023
View reviewed changes
Documentation/network/kubernetes/kubeproxy-free.rst Outdated Show resolved Hide resolved
Documentation/network/kubernetes/kubeproxy-free.rst Outdated Show resolved Hide resolved
Documentation/network/kubernetes/kubeproxy-free.rst Outdated Show resolved Hide resolved
@qmonnet qmonnet added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. kind/cleanup This includes no functional changes. release-note/misc This PR makes changes that have no direct user impact. labels May 10, 2023
@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 10, 2023
@qmonnet qmonnet mentioned this pull request May 10, 2023
Closed
@peterj
Copy link
Contributor Author

peterj commented May 10, 2023 •
edited

Could you please amend your commit to fix the description (you have the description of three different commits in it)? You may drop the Co-authored-by: tag here; if you prefer to keep it, I'd appreciate if you could use my work email (quentin@isovalent.com) rather than personal one that GitHub uses by default.

As far as I understand, GitHub is having internal issues that would explain most of the CI errors we observe.

The Netlify errors are not related to GitHub though:

6:16:37 PM: /opt/build/repo/Documentation/network/kubernetes/kubeproxy-free.rst:73: WARNING: Explicit markup ends without a blank line; unexpected unindent.
6:16:37 PM: /opt/build/repo/Documentation/network/kubernetes/kubeproxy-free.rst:94: WARNING: Literal block ends without a blank line; unexpected unindent.

Can you please look into this?

Looks like a merge gone wrong -- it should be fixed now. I think GH added the co-authored portion, modified it with the your work email.

I ran make docs locally with no errors now.

@peterj peterj requested a review from qmonnet May 10, 2023 20:20
@peterj peterj requested a review from qmonnet May 11, 2023 17:30
@peterj @qmonnet
docs: fix typos and formatting
3800621 
fix typos and formatting

Co-authored-by: Quentin Monnet <quentin@isovalent.com>
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
qmonnet
qmonnet approved these changes May 12, 2023
View reviewed changes
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

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

Thanks

@peterj
Copy link
Contributor Author

peterj commented May 16, 2023

@qmonnet what are the next steps for this PR? I see the branch if not up to date with main, but I am hesitant to click merge and get into the same cycle as I did with the previous PR (ie. unsigned commits, unclean commit history etc). Is update with rebase the right option at this point?

@qmonnet
Copy link
Member

qmonnet commented May 16, 2023

Hi, no need to rebase against main, unless there were a conflict (in which case I'd recommend fixing and rebasing locally before updating the branch, rather than using GitHub's button).

Here we're just missing a review from cilium/sig-k8s. @youngnick could you please take a look?

youngnick
youngnick approved these changes May 23, 2023
View reviewed changes
Copy link
Contributor

@youngnick youngnick left a comment

Choose a reason for hiding this comment

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

Sorry about the delay here.

@qmonnet
Copy link
Member

qmonnet commented May 24, 2023

Doc change only, and related tests passed. The full CI suite is not required, we're good to go

@qmonnet qmonnet added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label May 24, 2023
@squeed squeed merged commit db27ac0 into cilium:main May 24, 2023
36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@youngnick youngnick youngnick approved these changes

@qmonnet qmonnet qmonnet approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. kind/cleanup This includes no functional changes. 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.

None yet
4 participants
@peterj @qmonnet @youngnick @squeed