cancel
Showing results for 
Search instead for 
Did you mean: 

How to contribute to nuxeo documentation?

Sherry_Ummen
Champ on-the-rise
Champ on-the-rise

Hi,

Since I am trying out various things with Nuxeo on my Windows system, I find there are lot of places where the documentation is outdated. I would like to contribute to it by suggesting edits. Is it possible ?

Example : https://doc.nuxeo.com/nxdoc/setup-best-practices/ Here it says that in Windows nuxeo.conf will be found HKEY_LOCAL_MACHINE\SOFTWARE\%PRODNAME%\ConfigFile whereas its actually found here Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Nuxeo\ConfigFile

Similarly I have found other places.

Sherry

1 ACCEPTED ANSWER

Manon_Lumeau
Star Contributor
Star Contributor

Hi Sherry,

Thanks for your interest in our documentation! Our documentation is written in markdown and stored on GitHub. You can totally contribute to it on GitHub by creating a pull-request.

To do so:

  1. Go on the page that you want to edit, make sure that you are on the version that you want (there is a toggle button under the title of the page);
  2. Click on the Edit on Github button next to the last update date. It redirects you to the GitHub repository;
  3. Edit the page and create a pull request.

The documentation team will review your PR and merge it.

You will find some useful guidelines here to write documentation.

Thanks again for your help,

Regards,

Manon

View answer in original post

1 REPLY 1

Manon_Lumeau
Star Contributor
Star Contributor

Hi Sherry,

Thanks for your interest in our documentation! Our documentation is written in markdown and stored on GitHub. You can totally contribute to it on GitHub by creating a pull-request.

To do so:

  1. Go on the page that you want to edit, make sure that you are on the version that you want (there is a toggle button under the title of the page);
  2. Click on the Edit on Github button next to the last update date. It redirects you to the GitHub repository;
  3. Edit the page and create a pull request.

The documentation team will review your PR and merge it.

You will find some useful guidelines here to write documentation.

Thanks again for your help,

Regards,

Manon

Getting started

Find what you came for

We want to make your experience in Hyland Connect as valuable as possible, so we put together some helpful links.