TRI-ML / dgp

ML Dataset Governance Policy for Autonomous Vehicle Datasets
https://tri-ml.github.io/dgp/
MIT License
93 stars 63 forks source link

Docs build tracks latest docs but shows old version #116

Closed tk-woven closed 1 year ago

tk-woven commented 2 years ago

Description

See the live documentation here. In the upper-left corner, we mention DGP 1.0. At the time of this writing, though, we are on v1.3.

Improvement

Either automate part of the release process to bump version numbers in docs before building them, for example as part of a GitHub Actions workflow, or do this manually around the time of a version release.

tk-woven commented 1 year ago

BTW, @ryo-takahashi-1206 , @ykkawana-woven , this might be a good first issue if you have time and want to learn about how some things like docs are built in DGP.

ryo-takahashi-1206 commented 1 year ago

@tk-woven Thank you.
TBH, in dgp.git, I haven't done a lot except working with .proto so far.
I also think this minor bug fix is a good starting point to share maintainers' chores with Arene AI members. I will post something within a few days 🙇

tk-woven commented 1 year ago

Thanks; no worries, and no rush :) This is not the highest priority, but it is a bug we should fix eventually. I'm not a master of DGP either, but let me know if you have any questions!

ryo-takahashi-1206 commented 1 year ago

Either automate part of the release process to bump version numbers in docs before building them, for example as part of a GitHub Actions workflow, or do this manually around the time of a version release.

I feel like working on the former because:

Therefore, I'm now planning to embed git describe --tags --match 'v[0-9]*.[0-9]*' (e.g. v1.4-2-g7da558d) into the html.
Please let me know if someone has another opinion

Of course, it's ideal if we can fold all the past tags in Sphinx, though. Please let me try this next time :)

tk-woven commented 1 year ago

Sounds great to me! Thanks :)