https://pantsbuild.org/ logo
#development
Title
# development
h

hundreds-father-404

06/14/2022, 1:09 AM
Hi! Now that in-repo docs have landed as an experiment (https://github.com/pantsbuild/pants/pull/15810), it's important folks don't directly save edits to Readme.com without updating GitHub. Those won't be persisted @ancient-vegetable-10556 and I had the idea of tightening up the number of admins on Readme.com so that fewer people have to remember this gotcha. Thoughts?
b

bitter-ability-32190

06/14/2022, 1:36 AM
I'm ok with jumping ship, so long as I can find a way to "rpeview" my local writing
b

busy-vase-39202

06/14/2022, 1:37 AM
How long would we be without admin access? If a couple days, fine by me. If a couple weeks, hmmm. Mayyyyybe...?
h

hundreds-father-404

06/14/2022, 1:40 AM
This would be indefinitely. Chris and I strongly suspect we will want to migrate to Sphinx pretty quickly, but we have not committed to the time investment needed for that
so long as I can find a way to "rpeview" my local writing
True. I just finished doing my first substantial change, and it was very useful being able to hop into Readme.com's revised editor to preview. If we remove you from admin, then your only possibility is to use "Suggest edits" directly in Readme, and rely on an admin to port to GitHub So...maybe we don't take away privileges. Only, it's on you to remember you gotta update GH
b

busy-vase-39202

06/14/2022, 2:00 AM
Most of my edits traditionally have involved creating new pages or rearranging existing pages. Losing access to do that directly would make headache for me + whichever of you ends up having to be my surrogate for those things.
If ReadMe had a way for non-admins to create or move pages, I'd be more open to downgrading privs. But afaik those are admin-only features.
h

happy-kitchen-89482

06/14/2022, 8:48 AM
The creating and moving pages directly in readme is pretty much what we're trying to avoid, IIUC?
b

bitter-ability-32190

06/14/2022, 1:46 PM
Yeah. Maybe it wasn't clear, @Carina C. Zona, but the point of this is that anyone can move and create docs using markdown files in repo. So it's just a PR away
👍 1
a

ancient-vegetable-10556

06/14/2022, 3:35 PM
b

busy-vase-39202

06/14/2022, 3:53 PM
All pages, not just API documentation pages?
b

bitter-ability-32190

06/14/2022, 3:55 PM
Yup!
h

happy-kitchen-89482

06/14/2022, 4:33 PM
Well, the unversioned "custom pages" are debatable, there seems a lot less harm in keeping those in readme as the source of truth, at least for now. The ones that are oriented around devrel/marketing, as opposed to onboarding and using Pants
If we switch to sphinx then those would have to go along, but right now it's not clear that they have to?
b

busy-vase-39202

06/14/2022, 4:34 PM
I'd love to have them out of readme. Its custom pages come with awkward restrictions that it would be nice to be liberated from.
h

happy-kitchen-89482

06/14/2022, 6:01 PM
Even better 🙂
As long as you don't mind making changes in git. We can probably exempt some pages from code review, for faster turnaround.
a

ancient-vegetable-10556

06/14/2022, 6:01 PM
That’ll be a thing when we move to Sphinx
b

busy-vase-39202

06/14/2022, 6:01 PM
Yeah I love git.
a

average-vr-56795

06/17/2022, 11:29 PM
Should the 'update the site' section of https://www.pantsbuild.org/v2.12/docs/release-process#step-2-update-this-docs-site now get folded into the release prep PR, now that docs are in-repo?
w

witty-crayon-22786

06/17/2022, 11:40 PM
mm, yes. almost certainly.