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

refactor: Migrate Handbook to Sphinx Static Site Generator #404

Open
kgpayne opened this issue Apr 20, 2023 · 1 comment
Open

refactor: Migrate Handbook to Sphinx Static Site Generator #404

kgpayne opened this issue Apr 20, 2023 · 1 comment

Comments

@kgpayne
Copy link
Contributor

kgpayne commented Apr 20, 2023

Given the companies first language is python 🐍 and the use of Sphinx for other site in the Meltano estate (e.g. the SDK) it would be straight forward to migrate the existing handbook content and layout to Sphinx. The benefits of a switch include:

  • One less static site framework to learn (reduced learning curve for maintainers)
  • Direct reusability of assets across sites (consistency in look and feel)
  • Close parity of experience for content contributors (still just markdown in a directory tree)
@kgpayne
Copy link
Contributor Author

kgpayne commented Apr 20, 2023

In particular, this would more easy accommodate additional levels of hierarchy in the nav (which in Jekyll is a template html change).

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

No branches or pull requests

1 participant