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

doc: render tuf logo and favicon on rtd #1829

Merged
merged 1 commit into from
Feb 8, 2022
Merged

doc: render tuf logo and favicon on rtd #1829

merged 1 commit into from
Feb 8, 2022

Conversation

lukpueh
Copy link
Member

@lukpueh lukpueh commented Feb 7, 2022 •
edited
Loading

Fixes #

Description of the changes being introduced by the pull request:
Configure docs to display

  • tuf icon as favicon
  • tuf horizontal logo (white) in navbar

Please verify and check that the pull request fulfills the following
requirements:

  • The code follows the Code Style Guidelines
  • Tests have been added for the bug fix or new feature
  • Docs have been added for the bug fix or new feature

@lukpueh
doc: render tuf logo and favicon on rtd
cf9af04 
Configure docs to display
- tuf icon as favicon
- tuf horizontal logo (white) in navbar

Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
@lukpueh
Copy link
Member Author

lukpueh commented Feb 7, 2022

See preview here: https://theupdateframework--1829.org.readthedocs.build/en/1829/

@coveralls
Copy link

Pull Request Test Coverage Report for Build 1806227526

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 97.89%
Totals Coverage Status
Change from base Build 1805871284: 0.0%
Covered Lines: 1112
Relevant Lines: 1132
💛 - Coveralls

@jku
Copy link
Member

jku commented Feb 7, 2022

Nice. Some related thoughts:

  • Our README seems to use an already deleted logo svg from a completely different repository :)
  • We have various images in docs/images/ -- none of these seem to be used currently

Would it make sense to use that existing directory for your new files (and possibly delete the old files)?

@jku
Copy link
Member

jku commented Feb 7, 2022

If the source of these is https://github.com/cncf/artwork/tree/master/projects/tuf, we could leave a note mentioning that in the image directory

@lukpueh
Copy link
Member Author

lukpueh commented Feb 7, 2022 •
edited
Loading

Great point! The images dir slipped through my sweep in #1745.

I just copied the two images in this PR from the artwork repo (and modified them a little bit). I think it is safe to remove the contents from images... and probably the dir itself? I don't know if the docs dir becomes much cleaner with the two new images living in the images dir (would we also move the repository-library-design-*.jpgs?).

What I currently find more confusing there is the wild mix of general docs (adr, CHANGELOG, etc.) and RTD markup/content/config.

jku
jku approved these changes Feb 7, 2022
View reviewed changes
Copy link
Member

@jku jku left a comment

Choose a reason for hiding this comment

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

That makes sense, thanks.

Leaving for you to merge in case you did want to do the images cleanup here already (fine to leave it for future though)

@lukpueh lukpueh merged commit efc6877 into theupdateframework:develop Feb 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jku jku jku approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lukpueh @coveralls @jku