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

Significant docs cleanup and refresh #2691

Merged
merged 1 commit into from
Jan 5, 2024

Conversation

robscott
Copy link
Member

@robscott robscott commented Dec 22, 2023

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This PR is pretty massive, here's an attempt at a changelog:

Logo and Design

  • Logo files have been added
  • Logo replaces title in header
  • Logo added to main page
  • Header background/overall primary color changes to Kubernetes primary color
  • Updated main diagram on front page and added link to file that can be used to edit

Mesh

  • A new "Mesh" section has been added, including Overview, GAMMA, and Service Facets Pages. (None of this content is new, it's just all more neatly contained in a Mesh-specific section).
  • Once this merges, gateway-api.sigs.k8s.io/mesh will get you to this section
  • Redirects from old pages have been added

Layout

  • Tabs now show up on small displays (previously they'd hide below ~1200px width).
  • GEPs have been moved from "reference" to a new "enhancements" tab
  • Blog tab/navigation has been hidden, but individual pages remain for the sake of any old links out there
  • Sidebar navigation is now fully expanded by default (not sure about this one, but it mostly feels like an improvement)

Docs Consistency

  • A new documentation style guide has been added to extend the Kubernetes upstream one
  • Project name has been clarified as "Gateway API", references to "the Gateway API" have been corrected
  • "Experimental" and "Standard" channel callouts have been standardized
  • Absolute links have been replaced with relative ones wherever possible

Misc

  • Style of FAQs has been cleaned up throughout, now questions are included in navigation

Which issue(s) this PR fixes:
Fixes #2553

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Dec 22, 2023
@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 22, 2023
@k8s-ci-robot k8s-ci-robot added kind/gep PRs related to Gateway Enhancement Proposal(GEP) approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Dec 22, 2023
@robscott
Copy link
Member Author

Recommend spending some time looking at the deploy preview when reviewing this one: https://deploy-preview-2691--kubernetes-sigs-gateway-api.netlify.app/.

Adding a hold since this is a big PR and want to give people a chance to look through it.

/hold

@youngnick
Copy link
Contributor

Nice, this LGTM (as long as it merges after #2689 and I don't have to rebase 😄 )

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 22, 2023
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 5, 2024
Copy link
Contributor

@youngnick youngnick left a comment

Choose a reason for hiding this comment

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

LGTM aside from one thing, so I'll leave this for another round of changes, sorry @robscott.

- geps/gep-851/index.md
- geps/gep-1323/index.md
- geps/gep-1364/index.md
- Enhancements:
Copy link
Contributor

Choose a reason for hiding this comment

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

Does it make more sense to have this section sorted in roughly declining order of stability? I'm thinking:

  1. Memorandum
  2. Standard
  3. Experimental
  4. Implementable
  5. Provisional

Copy link
Member Author

Choose a reason for hiding this comment

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

Since this PR is big enough to conflict with ~everything docs related, I'm going to merge as is and make a follow up for this detail so I don't have to do any more rebases.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: robscott, youngnick

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Member

@shaneutt shaneutt left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 5, 2024
@robscott
Copy link
Member Author

robscott commented Jan 5, 2024

Will make a follow up PR to address @youngnick's final comment, but getting this in now to avoid more rebasing.

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 5, 2024
@k8s-ci-robot k8s-ci-robot merged commit 10e5f19 into kubernetes-sigs:main Jan 5, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. kind/gep PRs related to Gateway Enhancement Proposal(GEP) lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Formalize Project Naming Conventions
4 participants