Adjust title headings

[nebelsprachen]

Content Description

• Some of the titles use a mix of title case and sentence case. Since we are treating "Platform" as a proper noun, I left it capitalized. However, other terms like "integration" or "configuration" are not proper nouns, so they should likely be in lowercase to align with sentence case style.

• Slight rewrite to text and added commas for clarity

Note: The term "Platform" is not formatted consistently throughout the document. I opted to use it as a proper noun to align with the document's headings ( but it could go either way). Additionally, according to the Google style guide, UI elements should be formatted in bold typeface. There are a few instances where this formatting should be updated to match the style guide.

Preview Link

• Update headings and text
• Update headings for sentence case
• Add a comma
• Fix GitHub format typo

Internal Reference

n/a

[netlify]

✅ Deploy Preview for vcluster-docs-site ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	ae309a9
🔍 Latest deploy log	https://app.netlify.com/sites/vcluster-docs-site/deploys/679b88f1f32d4e000847eeb1
😎 Deploy Preview	https://deploy-preview-442--vcluster-docs-site.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[Piotr1215]

@nebelsprachen I had to approve/trigger the vale workflow (it needs to be done for all external contributors). As you can see, there are some vale rules violations. Could you please fix those? Please refer to the CONTRIBUTING.md to learn more about styling guidelines and working with vale.

Tip

you can find the exact rules violations in the Files changed tab

[nebelsprachen]

Thank you, @Piotr1215. I addressed some of the linter comments, but others seem more like suggestions rather than strict rules and may not be entirely correct. For example, one rule states that "admin" should not be capitalized, but in the given example, the text references a UI element, where capitalization seems be appropriate.

Another rule suggests using "the platform" instead of "the vCluster Platform," but this change could make the text ambiguous, especially for new users who may not be familiar with the product.

Also, mentioned in the comment above "platform" is formatted inconsistently throughout the docs. I am not sure if it is a proper noun, as in "the vCluster Platform" or if we are just referring to it as "the platform".

Lastly, sentence case headings are not used throughout the doc. Some of the pages use title case for the first level headings, and some other pages use title case for second level headings, or a mix of the two. The sidebar heading are in title case.

I tried to resolve some of the lint issues, but could not make the linter entirely happy.

[Piotr1215]

Vale rules override

In the case of admin not being capitalized, the CONTRIBUTING.md has a chapter dedicated to controlling vale issues.

Product naming

The product naming should be the platform, however front matter is an exception here where we want to improve the discoverability by search engines. Front matter is exempt from vale rules.

Note

add the above to the style guidelines

Inconsistent formatting

Not all documents were changed since I've introduced vale, so there are some older docs that will still have rules violations, and they will need to be fixed either when the doc is being changed or via spot-checks.