#766 Consistently using verbs in titles #1038
Conversation
…sidebars (last commit covered versioned docs)
…on, not how to provision a driver
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| title: Provisioning Drivers | |||
| title: About Provisioning Drivers | |||
There was a problem hiding this comment.
This is a special case. The page is about drivers that provision nodes and clusters. It's not about how to provision a node or cluster driver. Since the sidebar label is already 'About Provisioning Drivers' I went with that.
| @@ -326,7 +326,7 @@ const sidebars = { | |||
| }, | |||
| { | |||
| type: 'category', | |||
| label: 'Manage Clusters', | |||
| label: 'Cluster Administration', | |||
There was a problem hiding this comment.
This is another special case. The page is titled "Cluster Administration" and isn't a how-to. Instead, it contains a table of actions you can perform on clusters
|
I'm going to pause here since this PR is getting very large |
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| title: Monitoring Guides | |||
| title: Monitoring/Alerting Guides | |||
| @@ -260,11 +260,11 @@ | |||
| "description": "The label for category Provisioning Storage Examples in sidebar tutorialSidebar" | |||
| }, | |||
| "sidebar.tutorialSidebar.category.Manage Projects": { | |||
| "message": "Manage Projects", | |||
| "message": "Project Administration", | |||
There was a problem hiding this comment.
To match title, and to match the label in new user guides, "Cluster Administration"
| "description": "The label for category Manage Projects in sidebar tutorialSidebar" | ||
| }, | ||
| "sidebar.tutorialSidebar.category.Manage Project Resource Quotas": { | ||
| "message": "Manage Project Resource Quotas", | ||
| "message": "Project Resource Quotas", |
There was a problem hiding this comment.
Removed verb as it isn't really a how-to
| "description": "The label for category Launch Kubernetes with Rancher in sidebar tutorialSidebar" | ||
| }, | ||
| "sidebar.tutorialSidebar.category.Use New Nodes in an Infra Provider": { | ||
| "message": "Use New Nodes in an Infra Provider", | ||
| "message": "Launching New Nodes in an Infra Provider", |
There was a problem hiding this comment.
The actual title of this page is so long that I compromised with a shorter version that at least starts with the same word as the title
|
@martyav is this ready for review now? There were a number of commits made after the previous review request. |
|
@btat Yep, not adding anything more except if suggested. When I left off last, I had finished going through the Getting Started and How-to guides. I don't intend to go over other sections at this time |
...des/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-in-tree-vsphere.md
Outdated
Show resolved
Hide resolved
...des/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-in-tree-vsphere.md
Outdated
Show resolved
Hide resolved
...kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-out-of-tree-vsphere.md
Outdated
Show resolved
Hide resolved
...des/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-in-tree-vsphere.md
Outdated
Show resolved
Hide resolved
...kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/configure-out-of-tree-vsphere.md
Outdated
Show resolved
Hide resolved
Fixes #766
Reminders
See the README for more details on how to work with the Rancher docs.
Verify if changes pertain to other versions of Rancher. If they do, finalize the edits on one version of the page, then apply the edits to the other versions.
If the pull request is dependent on an upcoming release, make sure to target the release branch instead of
main.Description
This PR goes back and addresses a minor issue that was discussed some weeks ago, about page titles. I used the table in #753 to find pages that needed updating.
Comments
Should we also address pages that have dropdowns in the sidebar, such as https://ranchermanager.docs.rancher.com/pages-for-subheaders/configure-openldap? Notice that the page title has a gerund but the sidebar label does not.