Update the release instructions for docs/. (pantsbuild#18440)

Previously this was being handled out of band by folks in the know.
yardenshoham · Mar 7, 2023 · 81aeb2f · 81aeb2f
1 parent f2cdd9b
commit 81aeb2f
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/markdown/Contributions/releases/release-process.md b/docs/markdown/Contributions/releases/release-process.md
@@ -194,6 +194,12 @@ Go to the [documentation dashboard](https://dash.readme.com/). In the top left d
 
 Also, update the [Changelog](doc:changelog) page with the new release series at the top of the table. It's okay if there are no "highlights" yet.
 
+### Sync the `docs/` content
+
+See the `docs/NOTES.md` for instructions setting up the the necessary tooling your first time.
+On the relevant release branch, run `npx rdme docs docs/markdown --version v<pants major>.<pants minor>` with your key from <https://dash.readme.com/project/pants/v2.8/api-key>
+E.G: `npx rdme docs docs/markdown --version v2.8`.
+
 ### Regenerate the references
 
 On the relevant release branch, run `pants run build-support/bin/generate_docs.py -- --sync --api-key <key>` with your key from <https://dash.readme.com/project/pants/v2.8/api-key>.