docs icon indicating copy to clipboard operation
docs copied to clipboard

Docs-978 fully branched PGD 5.6

Open djw-m opened this issue 5 months ago • 3 comments

This is a future release branch - specific instructions must be followed when merging, see "Merging this branch" section, below. This branch shall not be merged until PGD 5.6 is released!

Please use this branch only for changes specific to version 5.6 - changes and corrections that apply to 5 should be made in short-lived branches that can be merged into develop and released promptly.

Working on this branch

Other people may be editing and altering this branch. Be sure to pull latest before beginning work - and be aware that this branch may be rebased on a regular basis to incorporate changes from the previous version. We recommend using git pull --rebase or setting pull.rebase to true in git config to avoid mistakes, e.g. run git config pull.rebase true on your local clone.

This branch will live for months, but try to merge and delete your branches within hours or days.

For changes that need review or feedback, create a branch based on this branch and request feedback on a PR before merging your changes into this branch.

Please use descriptive messages and comments for your commits and PRs - this allows other people working on this PR to see at a glance what is changing.

Good: "updated version to 5.6 in index.mdx" / "correct misspelled option in CLI reference"

Bad: "updated index.mdx" / "fixed typos"

Incorporating 5 updates

To bring in applicable changes that have been made to PGD 5, rebase this branch against develop and force-push. Be sure to review changes for areas that should be updated for 5.6. When resolving conflicts, defer to 5 except when changes in this branch are necessary to support 5.6.

Merging this branch

When PGD 5.6 is released, follow this procedure to complete the separation of documenation for 5 and 5.6:

  1. Rebase one last time (see above)
  2. Bring the 5 subdirectory back into the source tree:
    git checkout develop product_docs/docs/pgd/5/
    git commit -m "restore PGD 5 docs"
    git push
    
  3. Immediately merge this branch into develop.
  4. On a new branch off of develop:
    • Rewrite all /pgd/latest/... links in product_docs/docs/pgd/5/**/*.mdx to /pgd/5/...
    • Fix any redirect collisions that show up during a build (these will be redirects of the form /bdr/... that appear in both 5 and 5.6 trees)

djw-m avatar Sep 02 '24 09:09 djw-m