https://pantsbuild.org/ logo
Join Slack
Powered by
OK everyone, I suggest we set a deadline for the n...
# development
b
OK everyone, I suggest we set a deadline for the new docs site cutover being the 2.19 release. Pushing it past that would cause a bit of headache on the docs site and associated work, and aligning it with a release feels appropriate.
b
Could you describe the headaches you see? (My usual inclination would be to not tie together milestones that don’t need to be tied together, eg we’re already late with 2.19.)
b
• "latest version" redirects https://github.com/pantsbuild/pantsbuild.org/pull/35 • with 2.19 released, we'd be on the cusp of starting a 2.21 series, meaning all the bits involved with another version in the docs site off the top of my head
b
Hmmm, I wonder if we won't want to be doing a "big" release announcement at the same time as having a potentially-broken website
b
Such a vote of confidence 😅
b
Sorry, didn't mean it like that; just managing risk for a major change! The goal is to reduce stress/pressure on you (i.e. if things are broken-on-launch, that may be up to you to panic and fix immediately, but if we can do it more staged-ly, with more gates/rollbacks, then no panic required.)
And I personally would love to get 2.19 out very soon
h
Where should docs content update PRs go now, during the transition? If we merge a PR on https://github.com/pantsbuild/pantsbuild.org/ will it get stomped by a future one-time sync on switchover day? Or if we merge into the main repo will that get ignored now?
Or basically where is the source of truth now and where will it be after the switchover?
b
Our "prose" docs (the markdown dirnin the pants repo) gets synced over to that repo on release (we ought to change the edit URL on the docs site) Everything else ("evergreen" pages) live the the website repo
We can honestly decide however we want to slice the pie, but the way it is is just how the cookie crumbled
(I might be hungry 🤔)
h
Oh, I was assuming that the prose markdown docs will be permanently removed from pantsbuild/pants after the switchover?
b
That's an option, but I'd argue the cons outweigh the pros
h
OK, so manual updates will always go to pantsbuild/pants, and will be synced over as part of a release?
b
Yes? What do you mean by "manual"?
h
Humans improving the docs, something that needs to be reviewed by a human
as opposed to some technical thing that happens in the publishing flow
b
Ah ok then yeah 👍
h
Great, so pantsbuild/pants will remain the source of truth
Good to know
b
Yup! Atomic PRs, and auto cherry picking doc changes persist as they do today
Eventually, we'll have docs render previewing on PR... Eventually
h
I am very excited for all this
3 Views
Open in Slack
PreviousNext
Powered by