Update onboarding introduction page that edits should be made by github or gitbook?

[copperwiring]

As per todays discussion on slack, there seem to be two methods of editing gitbook:

• github (https://github.com/neuropoly/neuropoly-internal-docs/blob/master/onboarding/onboarding-intro.md)
• gitbook itself once people have access

There doesn't yet seem to be a consensus on which to use, however, the introduction page explicitly mentions GitHub.

This section includes information for getting started at NeuroPoly Lab. If you feel some information is missing, please feel free to edit this document or open a pull request on GitHub. Thank you! 🙏

It seems people have used both in the past. This can lead to confusions and conflicts if both mediums are used. Hence, we need to decide which of the two platform works seamlessly and update it accordingly

[taowa]

My personal opinion here is that the gitbook can be our "official" way to edit pages, and that edits through the git repo can be "at your own risk". Someone editing with git should be able to rebase as needed to fix whatever it is they're doing when a conflict arises. If we decide that we don't want to be using git to make changes, I'd wonder why we're even using a platform like gitbook. I might suggest that we make the default branches protected though, so that pull requests are effectively required.

[copperwiring]

Looping in @ahill187 as she had good insights on the relevant slack discussion.

[taowa]

I think that

My personal opinion here is that the gitbook can be our "official" way to edit pages, and that edits through the git repo can be "at your own risk". Someone editing with git should be able to rebase as needed to fix whatever it is they're doing when a conflict arises. If we decide that we don't want to be using git to make changes, I'd wonder why we're even using a platform like gitbook. I might suggest that we make the default branches protected though, so that pull requests are effectively required.

is the de facto way that we're doing this. Does anyone mind if I close this issue?

[kousu]

I have an opinion, which is to make Github the official way to edit: neuropoly/neuro.polymtl.ca#20 (comment), and to unprotect the branches.

I forgot this issue was open; I put the issue on the other repo because it concerns both repos. I'm going to close this; please give feedback on my plan on that issue!

[kousu]

We've taken my approach in #21.