tetrabiodistributed / papra

Documentation repo for PAPRa - an open-source hardware (OSHW) Powered Air-Purifying Respirator (PAPR)
https://tetrabiodistributed.github.io/papra
MIT License
4 stars 7 forks source link

Docops/fix edit button/41 #42

Closed capsulecorplab closed 3 years ago

capsulecorplab commented 3 years ago

closes #41

mmroden commented 3 years ago

Should this go directly to deploy? Should it go to a branch that we would have to merge in once we accept changes? How do we do rights management here, are only approved github accounts able to edit?

capsulecorplab commented 3 years ago

Should this go directly to deploy? Should it go to a branch that we would have to merge in once we accept changes? How do we do rights management here, are only approved github accounts able to edit?

we used to have a dev branch that served as the staging branch, but it was causing bottlenecks, since there wasn't anyone (besides me) to test local deployments before merging to the deploy branch. An alternative workflow would be to setup a CI/CD pipeline where merges to a staging branch would also deploy a preview-able documentation page, but GitHub doesn't support that capability (as far as I know); we would need to set something up like Netlify, which supports builds on pull requests

mmroden commented 3 years ago

Is the original assumption I had-- that we want to prevent non-authorized users from making direct changes- the right one?  If so, maybe we just remove the edit button and provide contact info for potential contributors? On Jul 14, 2021, 6:34 AM -0700, Sean Marquez @.***>, wrote:

Should this go directly to deploy? Should it go to a branch that we would have to merge in once we accept changes? How do we do rights management here, are only approved github accounts able to edit? we used to have a dev branch that served as the staging branch, but it was causing bottlenecks, since there wasn't anyone (besides me) to test local deployments before merging to the deploy branch. An alternative workflow would be to setup a CI/CD pipeline where merges to a staging branch would also deploy a preview-able documentation page, but GitHub doesn't support that capability (as far as I know); we would need to set something up like Netlify, which supports builds on pull requests — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub, or unsubscribe.

capsulecorplab commented 3 years ago

Currently, only people with write access to the repo can edit the page directly. The default GitHub behavior for the edit button for anyone without write access is to fork the repo. If we want to enforce that maintainers of the repo have a reviewer for edits, we should add branch protection to the default branch such that edits can only be made via pull requests that require a reviewer