Feature: Add a "how to contribute to the doc" guide

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

Feature: Add a "how to contribute to the doc" guide #18

Closed syphax-bouazzouni closed 1 year ago

syphax-bouazzouni commented 1 year ago

Context

See https://github.com/ontoportal/administration/issues/11

This PR adds a naive guide (just guided screenshots) of how to edit/contribute to this documentation, open for anyone who wants to consolidate it and make it more readable (redaction is not my strength)

Changes

Add a How to contribute to the doc page(https://github.com/ontoportal/administration/commit/05c84c120a7e6ea576aa3b60b6a04296284243d3)
Move the old maintaining doc to the Configuration section(https://github.com/ontoportal/administration/commit/51f28649f27fac8a1cd51416a764e403ddf14f53)
Don't display configuration docs in the sections tree (https://github.com/ontoportal/administration/pull/18/commits/620a8418e771aeb34c9a55c10b300827a98feb16)

Reference to the configuration docs in the home (https://github.com/ontoportal/administration/pull/18/commits/7deb12522b3094dcf3275e645647599b6c9d4ec0)

Preview

https://ontoportal-lirmm.github.io/documentation/docs/documentation-docs/how-to-contribute-doc/

xeniacs commented 1 year ago

Thanks for the work Syphax! A clarification question: In Home - Contributing section, the Contributing Guide links to an ncbo repository. This will be replaced with a page in this documentation, correct? I guess we need to agree on the content of the guide, but the ncbo one could be our starting point.

xeniacs commented 1 year ago

Currently the "Edit this page link on GitHub" is https://github.com/ontoportal/administration/tree/main/docs/documentation-docs/how-to-contribute-doc.md and it gives 404. What's the edit page for the ontoportal-lirmm.github.io? I would like to try out the editing process.

syphax-bouazzouni commented 1 year ago

Hi @xeniacs

This will be replaced with a page in this documentation, correct? I guess we need to agree on the content of the guide, but the ncbo one could be our starting point.

Indeed,

What's the edit page for the ontoportal-lirmm.github.io? I would like to try out the editing process.

The ontoportal-lirmm.github.io is my local instance, that I use only for testing and preview, if you want to edit the "how to contribute", which is only present in this pull request (not merged) , you need to contribute to this pull request by doing like so: how to edit contribute to an existent pull-request

xeniacs commented 1 year ago

Do I need editing rights? The Edit File choice is greyed out.

syphax-bouazzouni commented 1 year ago

@xeniacs I added you to the admins of this repo is it still greyed out?

xeniacs commented 1 year ago

Yes, still greyed out. Could it be because I've already approved the changes? I'll request to review again.

xeniacs commented 1 year ago

Aha! I need to be in the correct branch to be able to edit it seems.

syphax-bouazzouni commented 1 year ago

@xeniacs I sent you an invitation to the ontoportal-lirmm/documentation repo. Because I did an error and created my branch there; so only people from ontoportal-lirmm can edit this. Next time I (and we) will create our branches here so very can have access to edit it.

And normally the greyed-out will not be there.

syphax-bouazzouni commented 1 year ago

I merged this PR, I had @jonquet approval in person

jonquet commented 1 year ago

Good to me indeed. This is still setting up the structure of the doc. I have not yet contributed to the content.