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

Make auto-generated docs for TerriaJS version 8 #4502

Closed
4 tasks done
steve9164 opened this issue Jul 6, 2020 · 5 comments · Fixed by #4666
Closed
4 tasks done

Make auto-generated docs for TerriaJS version 8 #4502

steve9164 opened this issue Jul 6, 2020 · 5 comments · Fixed by #4666

Comments

@steve9164
Copy link
Member

steve9164 commented Jul 6, 2020

I have a half-auto generated docs process for TerriaJS version 8. It's roughly:

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:

  • Move markdown generation code from TerriaMap's index.js to somewhere in terriajs and use terriajs running on node
  • Change from using a list of model types to using all registered catalog items/groups/references. Or something
  • Make the command 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.
  • Add gulp docs back into CI
@soyarsauce
Copy link
Contributor

Once this is ready, we should have a v8 version of docs.terria.io (in parallel)

Or option 2 - swap docs with dropdown

@soyarsauce
Copy link
Contributor

soyarsauce commented Aug 17, 2020

Don't need decision now - but things to consider:

  • seo / multiple versions of duplicate content / confusing versioning
  • popular ways of dealing with this? e.g. kubernetes

@rowanwins rowanwins mentioned this issue Aug 25, 2020
9 tasks
@soyarsauce
Copy link
Contributor

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

@soyarsauce
Copy link
Contributor

Unsure if this will make the oct communications

@steve9164 steve9164 linked a pull request Feb 1, 2021 that will close this issue
9 tasks
@steve9164
Copy link
Member Author

steve9164 commented Feb 15, 2021

Closed as there's other tickets tracking this work. See especially #4666.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants