It's easy to edit our documentation online!

Documentation
,
1

One of our biggest motivations towards moving to MarkDown wasn’t just switching to a more widely used language. We use the MyST parser look there for syntax.

You can now edit documents online! Drive by editing is always a bonus no need to build the docs or have a huge time investment if you’re fixing a typo or language. How easy is it?

Let’s look at our Sources section on in the User Manual:

Maybe you’ve spotted an error? In the upper right you’ll see some useful buttons:

image

If you click on the first logo – which happens to be the logo for GitLab you’ll get a handy dropdown from there click Suggest edit.

This will take you to GitLabs single page editor if you then click Preview above the edit box you’ll get a live preview of the rendered document.

In order to create a merge request change the Target Branch from main to anything else such as test branch

image
image369×147 4.61 KB

And it will change to this:

image
image410×113 5.78 KB

Don’t forget about your commit message the first line is the subject then a blank space and the body for the rest.

image
image557×170 4.72 KB

Unfortunately there is no 80 character wrapping so you’ll have to be mindful of that once the branch is created the only way to edit after is by checking it out and re-pushing.

The branch will hang off of the main repository created this way that’s OK we’re aware and would rather have this feature available to us.

2

Thanks for posting this write up. I have used the editing for changes and it is a great way to make changes to the documentation. It is well worth spending a few minutes getting familiar with making changes this way.

The only thing to add is reviews and changes are separate commits which need to be squashed in the merge request. I cannot remember the exact details. It is not hard but it pays to double check things.

3

That’s only if you edit any changes online using the IDE which I didn’t talk about in my post I think that’s a topic on its own maybe.

You’re right though that if someone does do that the MR needs to be squashed and the commit message edited so it’s not crazy looking as the default is when the squash feature is used.