Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (31 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 2.33 KB

Contributing to docs.altinn.studio

The site is generated from markdown using the Hugo static site generator. We use YAML as front matter.

Initial setup

  1. Download and install Git and clone the altinn-studio-docs repository to a local folder:
git clone https://github.com/Altinn/altinn-studio-docs
  1. We recommend downloading and using visual studio code with
  2. Install Hugo (extended) for your platform

Build / Edit / Test locally

  1. Open the altinn-studio-docs repo-folder in visual studio code
  2. Run hugo server --navigateToChanged from command line. Now the docs is running locally at http://localhost:1313/
  3. Edit and save files in the content-folder to automatically get a new local build of the site refreshed in your browser, so you can test your changes locally.

Push your changes to GitHub

We recommend that you create a pull request when you want to share your changes with the rest of the world.

  1. Create a branch for your changes
  2. Create a pull request

Deploy

Whenever changes from your pull request are merged into the main-branch, an automatic deploy is updating https://docs.altinn.studio/

PS: If you don't have direct write access to the repo, you need to create a fork and submit a pull request from your fork.

Review

Remember to follow our code of conduct.

Links