-
Notifications
You must be signed in to change notification settings - Fork 358
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
Make auto-generated docs for TerriaJS version 8 #4502
Comments
Once this is ready, we should have a v8 version of docs.terria.io (in parallel) Or option 2 - swap docs with dropdown |
Don't need decision now - but things to consider:
|
Once we are closer to the v8 release, we make the v8 docs the main docs, and host v7 docs elsewhere with a link saying if you need old docs, go here - robots meta noindex meta tags to not be indexed. Host the v8 docs somewhere - @steve9164 to speak w/ @soyarsauce & look into auto hosting v8 docs so we can get it out |
Unsure if this will make the oct communications |
Closed as there's other tickets tracking this work. See especially #4666. |
I have a half-auto generated docs process for TerriaJS version 8. It's roughly:
mobx-generate-docs
TerriaMap branchmobx-generate-docs
terriajs branchgulp docs
(with a Python environment that has correct installed dependencies)But I haven't run this for about 6 months. It's time to automate this fully. There is some work on https://github.com/TerriaJS/TerriaMap/blob/mobx-generate-docs/index.js to generate markdown from the Trait system. This has been integrated into the old docs and deployed here: https://mobx-terria-docs.surge.sh/connecting-to-data/catalog-items/ (with the help of some terriajs changes here.
The docs generation should now be able to run in node (and without TerriaMap) now that the model & traits system can be built for and run in node (as of ~6 months ago).
Rough task list:
gulp docs
runnable again. It should probably build terriajs using the terriajs-node (tsc -b tsconfig-node.json
) and then generate markdown files from models & traits.gulp docs
back into CIThe text was updated successfully, but these errors were encountered: