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

K8s1.29+ck3 docs #13997

Merged
merged 5 commits into from
Jul 9, 2024
Merged

K8s1.29+ck3 docs #13997

merged 5 commits into from
Jul 9, 2024

Conversation

evilnick
Copy link
Contributor

Done

  • Updates various pages of K8s docs for 1.29+ck3 release

QA

  • Check out this feature branch
  • Run the site using the command ./run serve or dotrun
  • View the site locally in your web browser at: http://0.0.0.0:8001/
    • Be sure to test on mobile, tablet and desktop screen sizes

N.B. The content of these changes has already been reviewed

@webteam-app
Copy link

@evilnick
Copy link
Contributor Author

Just FYI the 'woke' fails are because we can't police URLs to other sites

@lizzochek lizzochek self-assigned this Jul 3, 2024
@lizzochek
Copy link
Contributor

lizzochek commented Jul 3, 2024

@evilnick where can I see the expected content for the pages and a full list of required changes? Please also provide links to pages no the demo that need to be checked

@lizzochek
Copy link
Contributor

Content looks good to me according to the PR you mentioned. Please fix listing errors and inclusive name check for me to review code

@evilnick
Copy link
Contributor Author

evilnick commented Jul 4, 2024

@lizzochek I literally can't fix the inclusive language check.

e.g.

[keystone-auth]: https://github.com/kubernetes/cloud-provider-openstack/blob/master/docs/keystone-auth/using-client-keystone-auth.md

it's a URL 🤷

- `nrpe-external-master` (provides: `nrpe-external-master` on KCP and KW)

it's the name of a deprecated interface which we replaced, but people still need to know what the old one was called so they can update it.

I can't add <!-- woke ignore --> lines before these things because the Markdown parser used on u.c then interprets everything until the next blank line as HTML which obviously messes everything up.

I will look at the jinja_lint test too, which I guess is new since we last updated K8s docs, but from a glance at the output it is complaining mostly about blank lines. The blank lines are usually only there to make the Markdown render properly, and, e.g. "The format for the --storage option is <storage pool>,<size>,<number>" is obviously not a collection of orphaned HTML tags. Any advice there appreciated!

@evilnick
Copy link
Contributor Author

evilnick commented Jul 8, 2024

@lizzochek

I have removed some anchors the lint-jinja was complaining about. All the other items are necessary either because they are references in code blocks, or blank lines to make the Markdown render properly. I think this test is misconfigured because it shouldn't really be running on Markdown files?

There is nothing else I can change on these pages to comply with the checks which doesn't either break the rendering or remove important information.

Copy link
Contributor

@kwmonroe kwmonroe left a comment

Choose a reason for hiding this comment

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

This looks great from a copy perspective, and as @evilnick notes, the woke check failures are expected due to external urls and the lint check failures are expected due to supposedly orphaned keys (even though they're syntactically correct in the code blocks) and blank lines for rendering purposes.

+1.

@evilnick evilnick merged commit 026e68e into canonical:main Jul 9, 2024
12 of 13 checks passed
@evilnick
Copy link
Contributor Author

evilnick commented Jul 9, 2024

Thanks @akbarkz

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.

None yet

5 participants