This repository has been archived by the owner on Jul 19, 2021. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What are you trying to accomplish with this PR?
Fix #917.
Related PR : #950
Contributing to docs should be as easy as commiting
.md
files for the maintainers.We can leverage Travis CI to run the build commands and deploy on the
gh-pages
branch for us whenever we merge documentation change ontomaster
.The file is pretty straightforward, but some notes :
There's three condition to run the deploy ;
master
branchdocs
folderWhy was this approach chosen
Docusaurus has a built-in command docusaurus-publish specifically for our case. The problem is that since
v0
isn't on Docusaurus, we have to work around and manually run the build command and copy the files over thegh-pages
branch.Future iterations
It would be great if we could also check in the modified files were in
v1
orv0
and only trigger the build necessary. Since the build process is fast (~2min for both) it doesn't really matter for nowInstead of cloning the repo with a GitHub access token, we could leverage SSH connection but it's not an easy task over Travis.