[Docs] New documentation site with vitepress - #2965
Conversation
Signed-off-by: distefanodevinj <ddistefano@foursquare.com>
|
Some thoughts on the tooling change... Kepler's doc setup has felt dated and I have avoided touching the docs for quite a while so an overhaul is welcome. As someone who moves between frameworks helping out with docs everywhere a proliferation of setups does generate a lot of friction. These website generator setups do require maintenance and it can require a fair bit of googling and experimentation to resolve breakages and issues. FWIW, we already use docusaurus (packaged in a maintained common module) for all the openvis frameworks. In addition we have a custom React app for the open visualization site. So even after this change, kepler will remain an outlier. Alignment is not always practical / the right choice but worth mentioning. |
|
The Gitbook was setup a long time ago, and I don't have access to it anymore. I think it's time to move a maintained solution. I am open to any suggestions. Most of the heavy lifting is to update the build script to generate markdowns based on the typescript code, which I can look into. I prefer a minimalist setup to host these markdowns, and ideally as little change as possible |
Currently we use gitbook for documentation, which hosts the website and syncs to this repository for changes.
A couple problems with this current approach:
Trying out the static site vitepress at the recommendation of @ilyabo -- so far seems to be extremely easy to set up, customize, and publish content to.
I won't be writing new docs in this PR and will instead focus on a migration and very basic restructure (seperating developer docs & kepler user guides. Maybe one more area for contribution gudies? Not sure, will seek some advice)