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

This PR ships versioning support. #3

Merged
merged 6 commits into from
Oct 6, 2020

Conversation

rexwangcc
Copy link
Contributor

@rexwangcc rexwangcc commented Oct 5, 2020

This PR ships versioning support, it is a working MVP, but not yet perfect. The following parts need to be improved, but can be future work:

  • The verionsing script has a lot of duplciated code and hard-coded values
    in order to support both versioning and i18n need to make it
    more sophisticated and less DRY.
  • The i18n switch with versioning is not perfectly smooth yet,
    it can jump back and forth if users decide to:
    • switch lang while reading a specific version
    • swithc versions on a non-EN lang
      this needs to be fixed along with the vuepress i18n support, which
      can be difficult.
  • Now it shows ALL versions in the dropdown menu, yarn also build all available versioned docs (this is the same behaivor as ReadTheDocs), however, I can see this can dramatically slow down doc writter's hot-reload if we have hundreds of versions in the future. We should only SHOW + BUILD, say 10 or 15 most recent versions, we should also consider ONLY release up-to minor (but no patch or release candidates versions) versioned documentations. This can be discussed in the main repo though.

Copy link
Member

@yuanming-hu yuanming-hu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! I'm not an expert in frontend development, but the changes here seem great!! (Meanwhile, I should probably start ripping http://taichi.graphics/me/ off http://taichi.graphics/ :-p)

README.md Outdated Show resolved Hide resolved
Co-authored-by: Yuanming Hu <yuanming-hu@users.noreply.github.com>
README.md Outdated Show resolved Hide resolved
@rexwangcc
Copy link
Contributor Author

rexwangcc commented Oct 5, 2020

Awesome! I'm not an expert in frontend development, but the changes here seem great!! (Meanwhile, I should probably start ripping http://taichi.graphics/me/ off http://taichi.graphics/ :-p)

Thanks for taking a look! I'm not familiar with frontend development either, and using this chance to learn more about the modern frontend technologies. I hope the this framework is not over-complicated and can help us spend minimal time on the infrastructure so we produce great documentation+tutorials+events+research-posts, etc. I'm also pretty certain there will be frontend exerts in the taichi community who can help us improve this site!

When it comes to go-live:

  • It's no hurry to clean up http://taichi.graphics but once it's done, please let me know, so I can do a quick scan through this repo for us to get prepared for the migration.
  • I'm writing up a markdown style guide in my spare time similar to this, which shall be in as part of the contribution guide by EOD.
  • I'm migrating the API docs and chinese docs as fast as I can, but not targeting finishing them by the migration, especially a lot of API docs are getting updated as of now and subject to change, plus the chinese docs are pretty outdated.
  • It would be appciated if @StephenArk30 who set up the initial chinese documentation workflow can shed some light on how to (or would it be possible to) set up the translation workflow on this repo.

@yuanming-hu
Copy link
Member

  • It's no hurry to clean up http://taichi.graphics but once it's done, please let me know, so I can do a quick scan through this repo for us to get prepared for the migration.

I'll try my best to have this done by this Sunday (Oct 11).

  • I'm writing up a markdown style guide in my spare time similar to this, which shall be in as part of the contribution guide by EOD.

Great! That would be very helpful to newcomers (and potentially existing members!)

  • I'm migrating the API docs and chinese docs as fast as I can, but not targeting finishing them by the migration, especially a lot of API docs are getting updated as of now and subject to change, plus the chinese docs are pretty outdated.

I think we can first set the new English version up, while still refer readers to the old Chinese docs on readthedocs. I guess there will be a way to reuse the po files, but clearly some investigation is needed. (We also need to update the translation files a bit...)

Since now the documents live in two copies (rst in the main repo and md here), the maintenance cost is high. I would suggest that we make public the English version soon to avoid maintaining two versions :-)

  • It would be appciated if @StephenArk30 who set up the initial chinese documentation workflow can shed some light on how to (or would it be possible to) set up the translation workflow on this repo.

Yeah, I believe @StephenArk30 will have insights on how to reuse the existing po files and set up the new documentation i18n workflow. We can ask if he is interested in this after the new English doc is up :-)

@rexwangcc rexwangcc merged commit f84afe0 into master Oct 6, 2020
@rexwangcc rexwangcc deleted the rex/implement-versioning-mechanism branch October 6, 2020 13:26
@writinwaters writinwaters mentioned this pull request Sep 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants