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

Add additional functionality to docs #265

Merged
merged 3 commits into from
Dec 5, 2021

Conversation

ThomasLaPiana
Copy link
Contributor

@ThomasLaPiana ThomasLaPiana commented Dec 2, 2021

Closes #260

Code Changes

  • add a github link
  • add an "edit this page" link
  • add an "update at" section

Steps to Confirm

  • run the docs locally, test the new buttons

Pre-Merge Checklist

  • All CI Pipelines Succeeded
  • Documentation Updated

Description Of Changes

Footer functionality is currently overwritten by our theme, but mkdocs supports all of the functionality we want without needing to add it explicitly to the footer. Here is a list of the changes:

  • Top-right corner now has a link to our GitHub repository and also shows release version, stars and forks
  • there is now a pencil icon at the top of every page that links directly to that page on github for easier editing
  • The bottom of every page now has a Last update: December 2, 2021 style footer that shows the last time the file was updated according to git. This is turned off when running locally because no git information exists, but when built for prod this will be included.

@ThomasLaPiana ThomasLaPiana self-assigned this Dec 2, 2021
@ThomasLaPiana ThomasLaPiana changed the title Add footer to docs Add additional functionality to docs Dec 2, 2021
@ThomasLaPiana ThomasLaPiana marked this pull request as ready for review December 2, 2021 19:40
Copy link
Contributor

@PSalant726 PSalant726 left a comment

Choose a reason for hiding this comment

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

I haven't had a chance to dig into it, but do you think there are any possible workarounds to override the theme's override of the footer? I ask because the pencil icon is a nice feature, but it only partially achieves what we want. It's fairly easy to miss, and what we're really looking for is an obvious call-to-action that makes it dead simple for readers to contribute.

If not, there's nothing blocking this for me.

docs/fides/mkdocs.yml Outdated Show resolved Hide resolved
@ThomasLaPiana
Copy link
Contributor Author

I haven't had a chance to dig into it, but do you think there are any possible workarounds to override the theme's override of the footer? I ask because the pencil icon is a nice feature, but it only partially achieves what we want. It's fairly easy to miss, and what we're really looking for is an obvious call-to-action that makes it dead simple for readers to contribute.

If not, there's nothing blocking this for me.

I feel your pain on this one, but we're deep into custom CSS and I don't want to override that for this one change. I agree its not optimal though, and will keep this in mind if we end up doing some CSS refactoring in the future

@ThomasLaPiana ThomasLaPiana merged commit 7a96aef into main Dec 5, 2021
@ThomasLaPiana ThomasLaPiana deleted the ThomasLaPiana-add-docs-footer branch December 5, 2021 06:04
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.

Add a footer to documentation pages that encourages contributions
2 participants