ontoportal / documentation

Source code for OntoPortal user, admin and developer guides
https://ontoportal.github.io/documentation
BSD 2-Clause "Simplified" License
3 stars 9 forks source link

Add a "how to contribute to the documentation" #11

Closed syphax-bouazzouni closed 1 year ago

syphax-bouazzouni commented 1 year ago

The issue

We have a centralized and open-sourced documentation https://ontoportal.github.io/administration/ , and ask people to contribute to it.

The problem is that we don't tell them (simply) the "how?", It may seem obvious for people used to working with GitHub, markdown, and GitHub pages. But it is not the case for everyone, and it's understandable we work with heterogeneous people (managers, researchers, interns, externs, newcomers, ...) whose main focus is not to spend their days writing markdowns and submitting pull requests.

My propositions

So my proposition would be to make things the most explicit possible, by doing these documentation pages

And for people that want (and need) to know the details:

syphax-bouazzouni commented 1 year ago

This will be transferred to a documentation page after

How to edit a page

1- Click on "edit this page"

At the bottom of each page, you will find a link that will take you to the correspond markdown file image

2- Edit the page

image

3- Create a pull request

image

syphax-bouazzouni commented 1 year ago

How to edit/contribute to an existent pull request

1- Click on "File changed"

image

2- Scroll to the file you want to edit and click on the edit button

image

3- Do your change and submit a commit

image