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

Update top level documentation pages for style consistency #5754

Merged
merged 9 commits into from
Jun 14, 2024

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Jun 14, 2024

Proposed changes

This pull request changes the top level pages of documentation to adhere with newer style guide conventions.

  • Horizontal rules at the end of sections
  • Sentence case for page titles and headings
  • Note formatting
  • Link introduction phrasing

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@ADubhlaoich ADubhlaoich requested review from a team as code owners June 14, 2024 08:32
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Jun 14, 2024
@ADubhlaoich ADubhlaoich self-assigned this Jun 14, 2024
@ADubhlaoich ADubhlaoich merged commit d7e499c into main Jun 14, 2024
28 checks passed
@ADubhlaoich ADubhlaoich deleted the f5-style-consistency-top branch June 14, 2024 14:59
pdabelf5 pushed a commit that referenced this pull request Jun 17, 2024
This commit changes the top level pages of documentation 
to adhere with newer style guide conventions.

* Horizontal rules at the end of sections
* Sentence case for page titles and headings
* Note formatting
* Link introduction phrasing

Co-authored-by: Venktesh Shivam Patel <[email protected]>
ssrahul96 pushed a commit to ssrahul96/kubernetes-ingress that referenced this pull request Jun 20, 2024
…5754)

This commit changes the top level pages of documentation 
to adhere with newer style guide conventions.

* Horizontal rules at the end of sections
* Sentence case for page titles and headings
* Note formatting
* Link introduction phrasing

Co-authored-by: Venktesh Shivam Patel <[email protected]>
ADubhlaoich added a commit that referenced this pull request Aug 23, 2024
This commit changes the top level pages of documentation
to adhere with newer style guide conventions.

* Horizontal rules at the end of sections
* Sentence case for page titles and headings
* Note formatting
* Link introduction phrasing

Co-authored-by: Venktesh Shivam Patel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

3 participants