Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.81 KB
Raw

Contributing to Altinn docs

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

Instructions

Initial setup

  1. Download and install Git and clone the docs repository to a local folder:
git clone https://github.com/altinn/docs
  1. We recommend downloading and using visual studio code for editing markdown.
  2. Download Hugo (version 0.29 or newer) for your platform, and place it in the folder, named as "hugo.exe" (on Windows).

Build / Edit / Test

  1. Open the docs repo-folder in visual studio code (or another editor)
  2. Run hugo server or click "Altinn docs" (Ctrl-Shift-D) in vs code. This generates the site and opens Chrome at http://loalhost:1313/docs/
  3. Edit any file in the content-folder or static-folder to get a new build of the site refreshed in your browser.

Deploy

Whenever changes are pushed to the docs-repository, a semi-automatic build is triggered updating https://altinn.github.io/docs/

If you don't have write access to the docs-repo, you need to create a fork and submit a pull request.

Links