Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs-978 fully branched PGD 5.6 #6017

Merged
merged 69 commits into from
Oct 15, 2024
Merged

Docs-978 fully branched PGD 5.6 #6017

merged 69 commits into from
Oct 15, 2024

Conversation

djw-m
Copy link
Contributor

@djw-m djw-m commented Sep 2, 2024

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 djw-m requested a review from a team as a code owner September 2, 2024 09:20
@djw-m djw-m added the deploy Add this label to a PR and it will automatically be deployed to netlify label Sep 2, 2024
@djw-m djw-m self-assigned this Sep 2, 2024
Copy link
Contributor

github-actions bot commented Sep 2, 2024

@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 2, 2024 09:30 Inactive
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 2, 2024 13:46 Inactive
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 4, 2024 07:24 Inactive
@josh-heyer
Copy link
Contributor

Heads up: I've slightly altered how reference index generation is invoked, to allow for multiple versions of PGD (or, future, anything else) to make use of this.

  • behavior is triggered by presence of a file named index.mdx.src. Any directory containing such a file will (eventually) get passed to refbuilder.js
  • refbuilder dependencies are initialized on process startup (right after printing the docs banner). This remains a bit ugly (should happen outside of build entirely), but at least not being invoked every createPages pass (this was the slowest part of running refbuilder previously)
  • any changes to input files will still potentially trigger multiple rebuilds in develop; they should be somewhat faster though.
  • refbuilder will not be invoked in CI (github actions) builds. This was only necessary in situations where files were missed anyway, and only led to issues.

@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 5, 2024 14:37 Inactive
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 9, 2024 23:52 Inactive
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 10, 2024 11:07 Inactive
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 11, 2024 15:48 Inactive
@josh-heyer josh-heyer force-pushed the DOCS-978-Full-Branch-5.6 branch from 6fd88a8 to 004687d Compare September 11, 2024 19:27
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 11, 2024 19:31 Inactive
@josh-heyer josh-heyer force-pushed the DOCS-978-Full-Branch-5.6 branch from 004687d to d9e248d Compare September 11, 2024 19:45
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 11, 2024 19:49 Inactive
@josh-heyer josh-heyer force-pushed the DOCS-978-Full-Branch-5.6 branch from f3a615c to 6a4788c Compare September 18, 2024 17:37
@josh-heyer
Copy link
Contributor

⚠Rebased! Pull latest before continuing work. See updated description (above) for details on how this branch should be handled before and during the PGD 5.6 release. Refer to https://github.com/EnterpriseDB/docs/blob/develop/docs-for-docs/agreements/product-version-fork.md for details.

@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 18, 2024 17:54 Inactive
@djw-m djw-m added deploy Add this label to a PR and it will automatically be deployed to netlify and removed deploy Add this label to a PR and it will automatically be deployed to netlify labels Sep 23, 2024
@djw-m djw-m force-pushed the DOCS-978-Full-Branch-5.6 branch from f134983 to 9c06240 Compare September 30, 2024 15:33
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 September 30, 2024 15:50 Inactive
@djw-m djw-m force-pushed the DOCS-978-Full-Branch-5.6 branch from 9344e24 to 020e2dd Compare October 2, 2024 15:35
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 October 2, 2024 15:38 Inactive
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 October 2, 2024 15:54 Inactive
@josh-heyer josh-heyer force-pushed the DOCS-978-Full-Branch-5.6 branch from 21d2539 to eca95d5 Compare October 8, 2024 16:33
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 October 8, 2024 16:47 Inactive
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 October 8, 2024 17:08 Inactive
@github-actions github-actions bot temporarily deployed to pr-6017-docs-978-full-branch-5.6 October 8, 2024 17:38 Inactive
jpe442 and others added 24 commits October 15, 2024 08:44
…ate current release notes in src dirs

Signed-off-by: Dj Walker-Morgan <[email protected]>
Signed-off-by: Dj Walker-Morgan <[email protected]>
Signed-off-by: Dj Walker-Morgan <[email protected]>
Signed-off-by: Dj Walker-Morgan <[email protected]>
Signed-off-by: Dj Walker-Morgan <[email protected]>
Signed-off-by: Dj Walker-Morgan <[email protected]>
@djw-m djw-m force-pushed the DOCS-978-Full-Branch-5.6 branch from fb72475 to af2c98f Compare October 15, 2024 07:44
@djw-m djw-m merged commit c2874d2 into develop Oct 15, 2024
2 checks passed
@djw-m djw-m deleted the DOCS-978-Full-Branch-5.6 branch October 15, 2024 07:49
@djw-m djw-m mentioned this pull request Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Add this label to a PR and it will automatically be deployed to netlify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants