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

Apply new RTD theme options #738

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

kprosise
Copy link
Contributor

Applied theme changes that are configurable without modifying CSS or HTML. Deeper changes to the theme can always be investigated later.

Changes of note:

  • "+" symbol in sidebar next to sections which can be expanded to show subsections. We may wish to investigate changing the color to increase visibility, if this is an option we want to add to the docs.

  • Background color of sidebar updated to match website

  • External links are styled, so as to indicate such.

QA steps: viewed rendered html in browser, ran linkcheck.

No associated issue, minor changes to test out.

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

This is just to test out some theme options, to see if we wish to adopt any of them.

@doanac
Copy link
Member

doanac commented Aug 16, 2024

@vanmaegima
Copy link
Member

Looking good. I like the + addition.

Applied theme changes that are configurable without modifying CSS or
HTML. Deeper changes to the theme can always be investigated later.

Changes of note:

* "+" symbol in sidebar next to sections which can be expanded to show
  subsections. We may wish to investigate changing the color to increase
  visibility, if this is an option we want to add to the docs.

* Background color of sidebar updated to match website

* External links are styled, so as to indicate such.

QA steps: viewed rendered html in browser, ran linkcheck.

No associated issue, minor changes to test out.

Signed-off-by: Katrina Prosise <[email protected]>
@kprosise kprosise force-pushed the refresh-theme-options branch from 81bce4d to 238994d Compare August 20, 2024 10:00
@kprosise kprosise marked this pull request as ready for review August 20, 2024 10:01
@kprosise
Copy link
Contributor Author

I changed the background color for the ToC sidebar, which makes the "+" a bit more visible.

@doanac
Copy link
Member

doanac commented Aug 20, 2024

@kprosise
Copy link
Contributor Author

Linkcheck error can be ignored.

@kprosise kprosise merged commit bcf53ac into foundriesio:main Aug 23, 2024
2 of 3 checks passed
@kprosise kprosise deleted the refresh-theme-options branch August 23, 2024 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants