/submariner-website

This is the submariner website source code (hugo based).

Primary LanguageCSS

title date weight
Contributing to the website
2020-02-19 22:03:26 +0100
5

The Submariner documentation website is based on hugo, grav, and the hugo-learn-theme and written in markdown format.

If you want to contribute I recommend reading the hugo-learn-theme documentation

You can always click the "Edit this page link" at the top right of each page, but if you want to test your changes locally before submitting you can:

  1. Fork the submariner-io/submariner-website on github

  2. Checkout your copy locally

$ git clone ssh://git@github.com/<your-user>/submariner-website.git
$ cd submariner-website
$ make server

  1. Open your browser on http://localhost:1313

  2. Edit files in src, the browser should automatically reload changes.

  3. Eventually commit, push, and pull-request your changes. You can find a good guide about the github workflow here: contributing to a github project