Jump to content

How to update online documentation


Recommended Posts



I spend much time updating the documentation online : I edit the file with the github editor, this creates a branch in my own repo, then I PR it.

I understand that these PR are merged because I received mails notifying it.


But when I come to the github doc site on the branch master, I can often see that my updates aren't in the master doc. So where are they then ?

Link to comment
Share on other sites

Oh sure, I close Tutorial Talk so that all documentation chatter lands in the pinned "Contributing to documentation 101" thread, and then you start another Tutorial Talk-like thread.  Way to go!  :D


Ok, but, back to Jerome's question... I'm interested in everything I can learn about our docs system.  I think a 'build' needs to be done... to get freshly-edited .md to show-up on the docs website, but I don't think that pertains to your question, J. 


Whomever answers... feel free to talk talk talk.  :)  In French = perfectly a-ok!  Then we'll put a link to THIS thread... into the pinned thread.

Link to comment
Share on other sites

Hi Jerome!


But when I come to the github doc site on the branch master


Do you mean on the github repo, or on the doc website ?



When you update the .md files, nothing appear on the doc.

Why ? Because there's a "build" part. This is used to transform the .md files to .html files. (plus create an index for the search system and some other things).

Link to comment
Share on other sites

There is a manual "build" action (as jaskar said) from merging PR you write to the documentation website.

The doc website is fully static: that means there is no database, no markdown dynamic retrieving and so on. An admin had to pull the whole repo, run the build command (grunt build) and commit it back to the repo.

Finally, the "master" branch of Github is merged with the "production" branch (also manually).


I try to run the merge and the build once every week, and DK do it sometimes too.


Don't worry J., your PR are not lost :)

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Create New...