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

Consider retiring mkdocs-asf-theme #86

Open
2 tasks
jtherrmann opened this issue Feb 6, 2025 · 1 comment
Open
2 tasks

Consider retiring mkdocs-asf-theme #86

jtherrmann opened this issue Feb 6, 2025 · 1 comment
Labels
Jira Task Create a Jira Task for this issue

Comments

@jtherrmann
Copy link
Contributor

jtherrmann commented Feb 6, 2025

Jira: https://asfdaac.atlassian.net/browse/TOOL-3478

Note: The above link is accessible only to members of ASF.


@jhkennedy suggested we might consider retiring this custom theme in favor of the standard https://github.com/squidfunk/mkdocs-material theme. I would probably agree, since keeping this theme up-to-date with upstream changes is a significant amount of work that involves copy-pasting (for example, see #44).

If we decide to move forward with this, we'd probably want to:

  • Try switching https://github.com/ASFHyP3/hyp3-docs to the upstream theme to see how severely it would impact the look and feel
  • Discuss with any other ASF teams who may be using this theme and offer to hand off ownership of this repository
@jtherrmann jtherrmann added the Jira Task Create a Jira Task for this issue label Feb 6, 2025
@jhkennedy
Copy link
Contributor

We'll also want to make sure we:

  • Keep the unified search bar (using standard mkdocs-material overrides)
  • Connect the site to Google Analytics appropriately

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Jira Task Create a Jira Task for this issue
Projects
None yet
Development

No branches or pull requests

2 participants