Skip to content

Migrate docs site to Docsify #21

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

Merged
merged 17 commits into from
Nov 29, 2022
Merged

Migrate docs site to Docsify #21

merged 17 commits into from
Nov 29, 2022

Conversation

galargh
Copy link
Contributor

@galargh galargh commented Nov 17, 2022

This PR enables migration from GitBook to Docsify. I used Docsify because it allowed me to use the exact same format/structure as GitBook. This made the migration process really quick.

It introduces a new landing page that is required by Docsify.

It sets up automated deployments of both master and v0.5.3 branches to GitHub Pages.

It removes Gitbook specific constructs from .md files.

Before this PR can be merged, we should:

  • update pages.yml so that it doesn't point at this branch
  • add favicon
  • add page metadata
  • migrate v0.5.3 branch to docsify

I'm leaving the above open until we agree with @laurentsenta this is the approach we want to take.

The current version of the docs site powered by Docsify can be viewed at: https://testground.github.io/docs/

@galargh galargh requested a review from laurentsenta November 17, 2022 14:03
@galargh galargh temporarily deployed to github-pages November 17, 2022 17:51 Inactive
@galargh galargh temporarily deployed to github-pages November 17, 2022 18:18 Inactive
@galargh galargh temporarily deployed to github-pages November 17, 2022 19:21 Inactive
@laurentsenta
Copy link
Contributor

@galargh result looks good, I'll review it today; two questions

  • What about we don't spend time on 0.5.3 and use that time to work on releasing 0.6.0? (I guess the previous doc will stay up for some time, and we can link to it)
  • Would it make sense to move the docs to the testground/testground repo? So that every change comes with a documentation change?

@galargh
Copy link
Contributor Author

galargh commented Nov 18, 2022

  • What about we don't spend time on 0.5.3 and use that time to work on releasing 0.6.0? (I guess the previous doc will stay up for some time, and we can link to it)

Totally! It was worth spending time thinking about 0.5.3 though because multi-version support in docs is not that obvious. Note to self: look if we can simplify multi-version/language support using https://github.com/palkan/docsify-namespaced (https://evilmartians.com/chronicles/easy-multi-language-multi-version-documentation-with-docsify-git-and-github-actions). At a first glance it looks nicer than what we currently have on this branch.

EDIT I decided not to pursue this now.

  • Would it make sense to move the docs to the testground/testground repo? So that every change comes with a documentation change?

Sounds great too! I'll move this version of repo to testground/testground/docs next week. I think it'll be easier to review in this repo though since all the files in testground/testground will be new.

@galargh galargh temporarily deployed to github-pages November 29, 2022 11:41 Inactive
@galargh galargh temporarily deployed to github-pages November 29, 2022 11:49 Inactive
@galargh
Copy link
Contributor Author

galargh commented Nov 29, 2022

@laurentsenta I thought of a pretty good reason why we might want to hold off on moving the docs to testground/testground - clone size. I don't suppose we want to make every testground user download 30mb worth of docs assets whenever they clone testground. Similarly, we don't want to refrain from adding assets to docs because it affects testground bundle size.

@galargh galargh temporarily deployed to github-pages November 29, 2022 12:03 Inactive
@galargh
Copy link
Contributor Author

galargh commented Nov 29, 2022

@laurentsenta My suggestion would be to:

  1. Merge Migrate docs site to Docsify (v0.5.3) #22
  2. Merge Migrate docs site to Docsify #21
  3. Update DNS to point at the new docs
  4. Reconsider moving docs to testground/testground once we have binary releases there

@galargh galargh merged commit 03d427f into master Nov 29, 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