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

docs: fix deployment resource type output #22002

Merged
merged 1 commit into from Nov 22, 2022

Conversation

cleverhu
Copy link
Contributor

@cleverhu cleverhu commented Nov 4, 2022

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.
  • Thanks for contributing!

fix deployment apiversion error
Fixes: #issue-number

docs: Fix `kubectl create` output in docs after some deployments have moved from K8s "extensions" to "apps".

@cleverhu cleverhu requested review from a team as code owners November 4, 2022 11:00
@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 Nov 4, 2022
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.

Hi, and thanks! Could you please provide some context on what the change is necessary? (Typically, linking to f4ec8ea in the commit description).

@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.12.4 Nov 7, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.10.17 Nov 7, 2022
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.11.11 Nov 7, 2022
@qmonnet qmonnet added the area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. label Nov 7, 2022
@joestringer joestringer added the release-note/misc This PR makes changes that have no direct user impact. label Nov 14, 2022
@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 Nov 14, 2022
Copy link
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

The changes LGTM, thanks. It would be nice to include the details of the corresponding commit as Quentin mentioned, but as a first PR focused primarily on docs I'm not too worried about it.

I've allowed the CI to run to check the docs build correctly.

@joestringer joestringer changed the title fix deployment apiversion error docs: fix deployment resource type output Nov 14, 2022
@joestringer
Copy link
Member

Smoke test hit known flake #22168 . Docs test passed.

@cleverhu
Copy link
Contributor Author

The changes LGTM, thanks. It would be nice to include the details of the corresponding commit as Quentin mentioned, but as a first PR focused primarily on docs I'm not too worried about it.

I'm sorry I forgot to modify commit. I'll change the commit description as soon as possible.

@joestringer joestringer self-assigned this Nov 15, 2022
@joestringer
Copy link
Member

OK, feel free to ping me when you have updated the PR.

@cleverhu cleverhu force-pushed the fix-apiversion branch 2 times, most recently from a16b3f9 to e4c1306 Compare November 15, 2022 02:27
@cleverhu
Copy link
Contributor Author

OK, feel free to ping me when you have updated the PR.

@joestringer I have updated the commit description, PTAL. Thanks a lot.

@michi-covalent michi-covalent added this to Needs backport from master in 1.10.18 Nov 15, 2022
@michi-covalent michi-covalent removed this from Needs backport from master in 1.10.17 Nov 15, 2022
@michi-covalent michi-covalent added this to Needs backport from master in 1.11.12 Nov 15, 2022
@michi-covalent michi-covalent removed this from Needs backport from master in 1.11.11 Nov 15, 2022
@cleverhu
Copy link
Contributor Author

Typically commit messages would start with a short one-liner like the title of the PR has, then the rest of the current commit message would follow. For example:

docs: fix deployment resource type output

Since k8s had remove support for extensions/v1beta1 API version after 1.16, we should update the docs to the latest and stable version.

Signed-off-by: cleverhu <shouping.hu@daocloud.io>

This would also help to resolve one of the CI complaints.

Done, PTAL.

@joestringer joestringer merged commit d5ada37 into cilium:master Nov 22, 2022
@joestringer
Copy link
Member

Thanks, merged.

@bimmlerd bimmlerd mentioned this pull request Dec 1, 2022
14 tasks
@pippolo84 pippolo84 mentioned this pull request Dec 6, 2022
8 tasks
@gandro gandro mentioned this pull request Dec 6, 2022
10 tasks
@thorn3r thorn3r added backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. and removed backport-pending/1.12 labels Dec 12, 2022
@joestringer joestringer moved this from Needs backport from master to Backport done to v1.10 in 1.10.18 Dec 15, 2022
@joestringer joestringer added this to Backport pending to v1.11 in 1.11.13 Dec 15, 2022
@joestringer joestringer removed this from Needs backport from master in 1.11.12 Dec 15, 2022
@joestringer joestringer moved this from Needs backport from master to Backport done to v1.12 in 1.12.5 Dec 15, 2022
@michi-covalent michi-covalent added this to Backport pending to v1.11 in 1.11.14 Jan 26, 2023
@michi-covalent michi-covalent removed this from Backport pending to v1.11 in 1.11.13 Jan 26, 2023
@michi-covalent michi-covalent added backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. and removed backport-pending/1.11 labels Jan 26, 2023
@michi-covalent michi-covalent removed this from Backport pending to v1.11 in 1.11.14 Jan 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.11 The backport for Cilium 1.11.x for this PR is done. backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.10.18
Backport done to v1.10
1.12.5
Backport done to v1.12
Development

Successfully merging this pull request may close these issues.

None yet

9 participants