We'd love to accept your contributions to this project! If you are a first time contributor, please review our Contributing Guidelines before proceeding.
- Review the commit guide we follow - ensure your commits follow our standards
- Hugo - building block for local development
-
Fork this repository
-
Clone this repository to your workstation:
# Clone the project
git clone [email protected]:go-vela/docs.git $HOME/go-vela/docs- Navigate to the repository code:
# Change into the project directory
cd $HOME/go-vela/docs- Point the original code at your fork:
# Add a remote branch pointing to your fork
git remote add fork https://github.com/your_fork/docs- Make sure to follow our PR process when opening a pull request
Thank you for your contribution!
We use Hugo to build our site.
You will need to install:
Docsy has some of it's own requirements, listed in their getting started docs.
- PostCSS
git submodule update --init --recursiveto update the submodule
Once you've got that taken care of, from the repo root folder, run:
hugo server -w