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

Discussion: remove versioning and upgrade to Docusaurus v2 #151

Closed
TomBrien opened this issue Feb 11, 2020 · 1 comment · Fixed by #152
Closed

Discussion: remove versioning and upgrade to Docusaurus v2 #151

TomBrien opened this issue Feb 11, 2020 · 1 comment · Fixed by #152
Assignees

Comments

@TomBrien
Copy link
Member

So as discussed on Discord a little. I think versioning is causing us a bit of pain. Main issue is that when someone uses the edit function these edits are made against the next version docs and require moving back to the 2.0.0 which are the landing version.

I've built a demo version of the docs site here from scratch and used Docusaurus 2 to do so. I ported over the conent but this is a couple of PRs out of date now but it is pretty much just a copy and paste the files job to update. Little summary

Cons

  • Docusaurus 2 is at a late-stage alpha at the moment, although it is pretty well documented and seemed fine to me
  • No translations at the moment, these are coming in Docusaurus 2 soon I believe, and I don't think they were working on the old site to be honest
  • I found Docusaurus 2 requires slightly stricter markdown. I.e. underscores required escaping or putting in code ticks (I see no case where the ever should not be!)
  • We lose the versioned docs (1.x had little in it). The can be enabled down the line if needed again if we have a version with major changes.

Pros

  • I was able to build a fresh version of the site with no leftovers from versioning
  • Docusaurus 2 has more useful behind the scenes features and more coming online
  • Edits done online will be in the landing version when merged with no need to port back to versioned docs
  • Pretty dark mode!
  • We lose the versioned docs!

Notes

I haven't enabled the search bar yet for the proof of concept page but this should be trivial on the deployment

@dshokouhi
Copy link
Member

I really like the new look from Docusaurus. Are the current docs translated at all? I think translation would be the only major thing to consider.

I am all for dropping the versioning. I think there are better ways to handle it, like archiving the older versions and placing them in a separate location. The dark mode looks great! I don't mind the stricter syntax, anything that we move to will probably have new syntax that we will need to learn anyways.

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 a pull request may close this issue.

3 participants