samredai opened a new issue #3616: URL: https://github.com/apache/iceberg/issues/3616
This is a follow up to PR #3378 which at its core was a mkdocs proposal on how to achieve versioned docs. Since then I've been doing a comparison of other static site frameworks to see if any can provide a significant improvement over mkdocs. I think [hugo](https://gohugo.io/) is a big winner here and I was able to get a hugo version of the site up very quickly with a landing page and versioning, all without much fuss. A separate but related proposal is to separate the docs out into their own iceberg-docs repo. To achieve versioned docs, it requires a custom deployment workflow that pushes branches automatically to the gh-pages branch (which we would change to the asf-site branch in an apache/iceberg-docs repo). However having this in the same repo as the source code could be noisy. Here is the prototype site that I put together in my personal repo so everyone could check it out: https://samredai.github.io/iceberg-docs-prototype/latest/ There are still some things that need to be cleaned up such as replacing the mkdocs variables with hugo variables in all of the markdown pages. If you go to docs part of the site and scroll down to the "Releases" section on the left, you can see what looking at a previous version site looks like. A trivial thing to add here would be top level banners for older versions that let the user know "You are not looking at the documentation for the latest version of Iceberg." https://user-images.githubusercontent.com/43911210/143689701-4e05fdd4-dd89-4741-9e89-917a92d0d86a.mp4 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
