Help

Last updated: 2022-02-29

How do I use these tutorials?

These are organized by feature in webtools. Click a topic in the left-hand menu to see the answers to common questions. You can quickly navigate to sub-features via the right hand menu.

How do I contribute to these documents?

General

Please feel welcome to fix any errors/omissions/typos - especially support! Your help will be useful in keeping these documents up to date.

These documents use Markdown.

Editing directly on Github

At the bottom of each tutorial page is a link that reads Edit this page. If you click it, you will be redirected to Github. If you receive an error that reads 404 - This is not the web page you are looking for it means that you either are not logged into your Github account or your account does not have permission to read from the private repository. Please contact someone with administrator access to the Github repository so you can be added.

Make the changes you want and give it a quick descriptive commit message. The changes should be automatically deployed and visible in a few minutes.

Cloning, running locally, and pushing new commits

The more manual way is to clone the project would be something like this:

git clone git@git.gitlab.r99.no:Servebolt/webtools-documentation.git

This is built on Docusaurus, so you'll need Node version 14 or above. If it's already installed, type the following:

cd webtools-documentation
npx docusaurus start

You should now be able to see the local webserver in your browser at http://localhost:3000. Changes made to the md documents, should trigger automatic reload of the page in your browser.

When you changes are finished and look good, commit your work with a message, and push your work to the server.

Here's a quick intro if you aren't familiar with Git - but it makes it sound a bit more complex than needed: Git introduction.

Feel free to reach out to a dev team member if you have any questions.