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.

Sign up for GitHub

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

Jump to bottom

Add version information to docs for api types #2169

Merged
merged 1 commit into from
Jul 10, 2023
Merged

Add version information to docs for api types #2169

merged 1 commit into from
Jul 10, 2023

Conversation

spencerhance
Copy link
Contributor

@spencerhance spencerhance commented Jul 7, 2023 •
edited
Loading

What type of PR is this?
/kind documentation

What this PR does / why we need it:

This PR creates a standard format for specifying version status of CRDs on the reference pages.

This also adds the pymdownx.details markdown extension to support expandable code blocks.

Which issue(s) this PR fixes:
This PR is related to #1823 but will not fix it entirely.

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. labels Jul 7, 2023
@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 7, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @spencerhance. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 7, 2023
@spencerhance spencerhance mentioned this pull request Jul 7, 2023
Open
@spencerhance
Copy link
Contributor Author

/assign @keithmattix

@spencerhance spencerhance force-pushed the docs-versions-1 branch 2 times, most recently from 0e52098 to 9375661 Compare July 7, 2023 00:10
@robscott
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 10, 2023
robscott
robscott reviewed Jul 10, 2023
View reviewed changes
Copy link
Member

@robscott robscott left a comment

Choose a reason for hiding this comment

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

Thanks @spencerhance! Have some ideas for formatting that apply throughout, but otherwise LGTM.

site-src/api-types/gateway.md Outdated Show resolved Hide resolved
site-src/api-types/grpcroute.md Outdated Show resolved Hide resolved
@spencerhance
Copy link
Contributor Author

Thanks @robscott @keithmattix !

I've updated the PR to use the new formatting. Here are some screenshots of the rendering. Note that I had to include an additional md extension to support the collapsible blocks.

Collapsed View
Screenshot from 2023-07-10 10-31-07
Expanded View
Screenshot from 2023-07-10 10-31-15
Experimental Channel Example
Screenshot from 2023-07-10 10-31-24

@robscott
Copy link
Member

Thanks @spencerhance! That turned out great. I'll defer to someone else like @keithmattix or @shaneutt for LGTM.

/approve

@robscott robscott requested a review from shaneutt July 10, 2023 18:03
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

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

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 10, 2023
@keithmattix
Copy link
Contributor

Great to see this work done! Thanks @spencerhance
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 10, 2023
@k8s-ci-robot k8s-ci-robot merged commit 5889896 into kubernetes-sigs:main Jul 10, 2023
@spencerhance spencerhance deleted the docs-versions-1 branch July 10, 2023 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robscott robscott robscott left review comments

@keithmattix keithmattix Awaiting requested review from keithmattix

@shaneutt shaneutt Awaiting requested review from shaneutt

Assignees

@keithmattix keithmattix

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. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@spencerhance @k8s-ci-robot @robscott @keithmattix