hundreds-father-404
04/20/2022, 3:24 PMenough-analyst-54434
04/20/2022, 3:26 PMbitter-ability-32190
04/20/2022, 3:31 PMhundreds-father-404
04/20/2022, 3:31 PMbitter-ability-32190
04/20/2022, 3:31 PMhundreds-father-404
04/20/2022, 3:31 PMin-repo docs empower non-maintainers to edit the docsThey can do this via "suggest edits" button, which people often do use. Thoughts on which is more empowering?
enough-analyst-54434
04/20/2022, 3:32 PMin-repo docs empower non-maintainers to edit the docs, FWIWThis was nacked by the 2nd wisdom phase. Some consensus said commits were hard and discouraged non-maintainer contribution to docs - notably fixes.
curved-television-6568
04/20/2022, 3:32 PMenough-analyst-54434
04/20/2022, 3:32 PMhundreds-father-404
04/20/2022, 3:32 PMand allows docs to be changed atomically with codeThis would be great for making the docs audit I do every major release less painful. It usually ends up taking me 3-4 days to audit 🤷
enough-analyst-54434
04/20/2022, 3:33 PMbitter-ability-32190
04/20/2022, 3:33 PMhundreds-father-404
04/20/2022, 3:34 PMI would definitely encourage, as always, a wisdom thrash post-mortem if we switch back.I am probably rewriting my recollection of events, but I remember the number one reason we changed to read me is that we needed versioning of the docs. The number two reason is that we wanted the docs to look prettier
E.g. going through the test suite is annyoing, perhaps we can find out how to skip that, etc...Yeah we skipped CI for docs only changes
enough-analyst-54434
04/20/2022, 3:36 PMbut I remember the number one reason we changed to read me is that we needed versioning of the docs. The number two reason is that we wanted the docs to look prettierYou can clearly do both and have the primary docs source come from the repo as is being discussed now and as it was in the 1st phase of wisdom with the confluence plugin / doc targets.
hundreds-father-404
04/20/2022, 3:52 PMThe big problem here is can you turn off edits in Readme?This has not been an issue for the generated reference docs. The few people with edit access to read me.com are trained to not edit directly. When users suggest an edit, we comment on their suggested change redirecting them to make a pull request
happy-kitchen-89482
04/20/2022, 4:27 PMenough-analyst-54434
04/20/2022, 4:33 PMhappy-kitchen-89482
04/20/2022, 4:34 PMbitter-ability-32190
04/20/2022, 4:36 PMancient-vegetable-10556
04/20/2022, 4:40 PMmain
) , the relevant docs are updatedhundreds-father-404
04/20/2022, 7:34 PMbitter-ability-32190
04/26/2022, 10:10 PMhundreds-father-404
06/01/2022, 10:24 PM