-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Run build on push. Updated instructions in README.md
- Loading branch information
Showing
2 changed files
with
36 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,53 @@ | ||
# Website | ||
# LM-Commons Documentation Website | ||
|
||
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. | ||
The LM-Commons Documentation Website is built using [Docusaurus](https://docusaurus.io/). | ||
|
||
If you want to make a contribution to the documentation, please follow these | ||
instructions: | ||
|
||
1. Fork the `master` branch of this repository to your GitHub profile. Do not fork the `gh-pages` branch as it only contains the "built" version. | ||
2. Create a branch to work on your changes | ||
3. Test your changes locally (see below for instructions on how to use Docusaurus) | ||
4. Create a Pull Request against the `master` branch to submit your changes | ||
|
||
|
||
## Install and Develop with Docusaurus | ||
|
||
This is not a tutorial on how to use Docusaurus. Please refer to Docusaurus documentation. | ||
|
||
### Installation | ||
|
||
On your local fork of the LM-Commons Documentation, use `yarn` to install | ||
the Docusaurus dependencies. | ||
|
||
``` | ||
$ yarn | ||
``` | ||
|
||
### Local Development | ||
|
||
``` | ||
$ yarn start | ||
``` | ||
Once the dependencies are installed, you can make changes to the documentation source files. | ||
|
||
Typically, only the files located under `/docs`, `/src` and `/blog` should be changed. | ||
|
||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
Changes to the navigation and footer are made to the `docusauraus.config.js` file. | ||
|
||
### Build | ||
To test locally your changes, run: | ||
|
||
``` | ||
$ yarn build | ||
$ yarn start | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
||
### Deployment | ||
This command starts a local development server and opens up a browser window. Most changes are reflected live | ||
without having to restart the server. | ||
|
||
Using SSH: | ||
## Test builds | ||
|
||
``` | ||
$ USE_SSH=true yarn deploy | ||
``` | ||
A GitHub action is define to test builds. It will run on push to your fork. | ||
|
||
Not using SSH: | ||
## Submit changes | ||
|
||
``` | ||
$ GIT_USER=<Your GitHub username> yarn deploy | ||
``` | ||
Once you are satisfied with your changes and the `Build GitHub Pages No Deploy` action has | ||
passed successfully, then create and submit a Pull Request against the `master` branch of | ||
the repository. | ||
|
||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. |