mistercrunch opened a new issue #10088: URL: https://github.com/apache/incubator-superset/issues/10088
# work in progress! ## [SIP] modernize/facelift superset.apache.org ### Motivation Our current documentation at superset.apache.org has a certain number of issues: 1. look/feel is dated 1. RST/Sphinx is a fading/dying standard, markdown seems much more popular 1. Content is a bit of a patchwork, needs review/restructure/rewrite This SIP looks to address #1 and #2, and hope that those provide a foundation to docs that people want to contribute to and improve, content-wise. ### Proposed Change Migrating the current website from/to: - **framework**: moving from Sphinx to Gatsby / DocZ - **language**: moving from RST to markdown - **hosting**: moving from readthedocs to GitHub Pages (or similar) Gatsby would allow us to build a great, fast and modern static site. It provides a lot of flexibility / extensibility if we wanted to do more complex things like exposing a community blog. Markdown is a more common markup language for docs. Most people know it or can learn it very quickly, including tech writers, it's becoming fairly standard. ### New or Changed Public Interfaces N/A ### New dependencies Gatsby / Docz and whatever plugins and things we need there ### Migration Plan and Compatibility Would keep everything under the current main repo under `docs/` * individual RST files need to be converted to MD, this can be automated https://cloudconvert.com/rst-to-md * build a new Gatsby / DocZ ### Rejected Alternatives - Improving / theming readthedocs ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
