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 documentation dependencies and add dark mode #3109

Merged
merged 7 commits into from
Apr 3, 2024

Conversation

embik
Copy link
Member

@embik embik commented Apr 3, 2024

Summary

This PR is a general sweep at our documentation and does the following things:

  • Update all python dependencies used to build the documentation. I've eliminated "saved" dependencies of the packages we actually need, so we don't need to go over updating all of them. We only care about mkdocs, its extensions and mike.
  • Add a dark mode based on device preferences, but it can also be switched via the navigation toggle.
  • Rename the page from "kcp Documentation" to "docs.kcp.io" because I much better liked the look of it in the top navigation.
  • Make the top navigation match the theme by either turning white or black for good contrast with the kcp logo.
  • Transform top-level sections into tabs. I have not reordered content, but in my opinion this is the perfect way to group documentation by personas (users, admins, developers) in the future.
  • Update logo and favicon to the new official artwork.
  • Remove the OWNERS file so the top-level OWNERS file is effective in docs/ in the future.

The new docs website can be reviewed by running make deploy-docs serve-docs on this branch, but here's two screenshots to get a feeling:

Light Mode Dark Mode
Screenshot 2024-04-03 at 16 07 29 Screenshot 2024-04-03 at 16 19 12

Related issue(s)

Release Notes

NONE

@kcp-ci-bot kcp-ci-bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates the PR's author has signed the DCO. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 3, 2024
@embik embik changed the title 📖 Update documentation dependencies, add dark mode and introduce section tabs 📖 Update documentation dependencies and add dark mode Apr 3, 2024
@embik
Copy link
Member Author

embik commented Apr 3, 2024

/cc @sttts

@kcp-ci-bot kcp-ci-bot requested a review from sttts April 3, 2024 14:11
@sttts
Copy link
Member

sttts commented Apr 3, 2024

/lgtm
/approve

@kcp-ci-bot kcp-ci-bot added the lgtm Indicates that a PR is ready to be merged. label Apr 3, 2024
@kcp-ci-bot
Copy link
Contributor

LGTM label has been added.

Git tree hash: a4493dee8afb47ef5625ba4f27af50c8ebd79bda

@kcp-ci-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sttts

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

@kcp-ci-bot kcp-ci-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 3, 2024
@kcp-ci-bot kcp-ci-bot merged commit b46e66f into kcp-dev:main Apr 3, 2024
17 checks passed
@embik embik deleted the mkdocs-update branch April 3, 2024 14:41
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. dco-signoff: yes Indicates the PR's author has signed the DCO. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants