-
Notifications
You must be signed in to change notification settings - Fork 1.8k
bugfix: standardise and dedupe chapter titles #83386
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
bugfix: standardise and dedupe chapter titles #83386
Conversation
|
@kalexand-rh @bscott-rh @sheriff-rh Mentioning you all, as GH Issue template requests @openshift/team-documentation [which does not work] is mentioned after PR is raised. |
|
Hi @sean-freeman. Thanks for your PR. I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
@kalexand-rh @bscott-rh @sheriff-rh Can you please review this PR? I would prefer to avoid merge conflicts which is more likely the longer this PR is open. |
|
The decision was made during the 4.16 reorgs to remove "with installer-provisioned infrastructure" and "with user-provisioned infrastructure" from the assembly titles to improve readability. |
|
@sean-freeman my apologies, I closed this PR with a misunderstanding about what you were doing. The phrase "with installer-provisioned infrastructure" and "with user-provisioned infrastructure" is being removed from the topic map (left hand TOC) assembly names, but the headings inside the actual assemblies can still have that phrase for SEO reasons. Note that the full phrase should be used, not the acronym "UPI" or "IPI". |
|
@bscott-rh Prior to any changes to this PR, please confirm below. Reference descriptions:Results in below accurate terminology and phrasing:
Throughout documentation, short references used are:
|
See prior message @bscott-rh , please confirm before PR is amended |
I understand that there are some places where UPI and IPI are still present in the documentation. I am OK with adding "with user-provisioned infrastructure" and "with installer-provisioned infrastructure" to the headings of the "Preparing to install a cluster" assemblies so that they are consistent with vSphere |
|
Issues go stale after 90d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle stale |
|
PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
Stale issues rot after 30d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle rotten |
|
Refer to #88715 |
Where the new style has a chapter break to differentiate between IPI and UPI, some chapter titles are identical which will cause difficulties with SEO and end-user usage (finding the page, and not ignoring the page as a duplicate when there is different content on the page). In addition, VMware vSphere chapter titles do this inconsistently and with the long name even though the chapter menu uses the full name - so rebaseline to
with IPIandwith UPIacross all vendor content.Version(s):
4.17, do not cherry pick as this file is likely to have changed between each version
Issue:
QE review:
Additional information: