Skip to content

Fix doc building and unreadable mermaid #4179

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
Merged
k8s-ci-robot merged 2 commits into from
Oct 17, 2025
Merged

Fix doc building and unreadable mermaid #4179

k8s-ci-robot merged 2 commits into from
Oct 17, 2025

Conversation

@Stevenjin8
Copy link
Contributor

@Stevenjin8 Stevenjin8 commented Oct 16, 2025

What type of PR is this?
/kind documentation

What this PR does / why we need it:

Currently, the mermaid diagram for the backendtlspolicy is unreadable.

image

It seems like mermaid is not picking up on color:fff, so we can just make the background color a bit lighter

image

Also, fix some notes on how to build docs.

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. labels Oct 16, 2025
@k8s-ci-robot k8s-ci-robot requested a review from kflynn October 16, 2025 15:22
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 16, 2025
@k8s-ci-robot k8s-ci-robot requested a review from robscott October 16, 2025 15:22
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Oct 16, 2025

Welcome @Stevenjin8!

It looks like this is your first PR to kubernetes-sigs/gateway-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gateway-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 16, 2025
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Oct 16, 2025

Hi @Stevenjin8. 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-sigs/prow repository.

@Stevenjin8
Copy link
Contributor Author

Stevenjin8 commented Oct 16, 2025

I have no strong feelings about the #3af specifically.

candita
candita reviewed Oct 16, 2025
View reviewed changes
site-src/contributing/devguide.md
Copy link
Contributor

@candita candita Oct 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the contribution @Stevenjin8. Can you add this devguide change to a different PR? Or just add your suggestion without removing the old one? And also add a note to the commit message about what problem you're fixing in the devguide?

Copy link
Contributor Author

@Stevenjin8 Stevenjin8 Oct 16, 2025

Choose a reason for hiding this comment

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

@candita done thanks!

@Stevenjin8
Make mermaid diagram more readable
578dd61 
Use lighter colors over dark text
@rikatz
Copy link
Member

rikatz commented Oct 16, 2025

what if we just don't set the style at all, like we do on https://deploy-preview-4179--kubernetes-sigs-gateway-api.netlify.app/geps/overview/? wouldn't that be better?

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 17, 2025
@youngnick
Copy link
Contributor

youngnick commented Oct 17, 2025

/ok-to-test
/approve

@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 Oct 17, 2025
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Oct 17, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Stevenjin8, 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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 17, 2025
@rikatz
Copy link
Member

rikatz commented Oct 17, 2025

/lgtm
Thank you!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 17, 2025
@k8s-ci-robot k8s-ci-robot merged commit 7477dba into kubernetes-sigs:main Oct 17, 2025
20 checks passed
tylerauerbeck pushed a commit to tylerauerbeck/gateway-api that referenced this pull request Nov 27, 2025
@Stevenjin8 @tylerauerbeck
Fix doc building and unreadable mermaid (kubernetes-sigs#4179)
2b98709 
* Make mermaid diagram more readable

Use lighter colors over dark text

* remove style
@Stevenjin8 Stevenjin8 mentioned this pull request Dec 5, 2025
Closed
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kflynn kflynn Awaiting requested review from kflynn

@robscott robscott Awaiting requested review from robscott

1 more reviewer

@candita candita candita left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@rikatz rikatz

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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@Stevenjin8 @k8s-ci-robot @rikatz @youngnick @candita