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.

Sign up for GitHub

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

Jump to bottom

Restructure the Consistency/Conflicts section in PGD docs #5804

Merged
merged 24 commits into from
Jul 9, 2024
Merged

Restructure the Consistency/Conflicts section in PGD docs #5804

merged 24 commits into from
Jul 9, 2024

Conversation

jpe442
Copy link
Contributor

@jpe442 jpe442 commented Jun 25, 2024 •
edited
Loading

What Changed?

Breaks up the Conflicts section of the PGD Consistency docs into multiple pages. Splits out command references to Reference section.

@jpe442 jpe442 marked this pull request as ready for review June 26, 2024 17:20
@jpe442 jpe442 requested review from djw-m and piano35-edb as code owners June 26, 2024 17:20
@jpe442 jpe442 added the deploy Add this label to a PR and it will automatically be deployed to netlify label Jun 26, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 26, 2024 •
edited
Loading

🚀 Deployed on https://deploy-preview-5804--edb-docs-staging.netlify.app

@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 June 26, 2024 19:32 Inactive
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 June 26, 2024 20:20 Inactive
djw-m
djw-m reviewed Jun 27, 2024
View reviewed changes
Copy link
Contributor

@djw-m djw-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reference section links are all broken (they still refer as if they were in the actual docs)

I'd break up the functions from the lists, which will also let you prefix the lists section otherwise it could well clash.

Side note: this is now a really difficult PR to review with a lot of other stuff merged in. Wondering if there's a way to clean it up a bit or (hush ma mouth) make a new branch and cherry pick the real changes over.

product_docs/docs/pgd/5/reference/conflicts.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/reference/conflicts.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/reference/conflicts.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/reference/conflicts.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/reference/conflicts.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/reference/conflicts.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/reference/conflicts.mdx Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 June 27, 2024 18:01 Inactive
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 June 27, 2024 18:37 Inactive
@jpe442
Copy link
Contributor Author

jpe442 commented Jun 27, 2024 •
edited
Loading

I'd break up the functions from the lists, which will also let you prefix the lists section otherwise it could well clash.

I think I am following this. Are you suggesting two different reference pages, one for the functions and one for the lists? As opposed to the one page for both that I have now?

@jpe442
Copy link
Contributor Author

jpe442 commented Jun 27, 2024

Side note: this is now a really difficult PR to review with a lot of other stuff merged in. Wondering if there's a way to clean it up a bit or (hush ma mouth) make a new branch and cherry pick the real changes over.

I will attempt to do so...

@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 June 27, 2024 18:50 Inactive
@jpe442 jpe442 force-pushed the pgd/consistency/DOCS-287 branch from bca1cc9 to 418bc59 Compare June 28, 2024 15:47
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 June 28, 2024 15:51 Inactive
@jpe442
Copy link
Contributor Author

jpe442 commented Jul 1, 2024

Side note: this is now a really difficult PR to review with a lot of other stuff merged in. Wondering if there's a way to clean it up a bit or (hush ma mouth) make a new branch and cherry pick the real changes over.

I will attempt to do so...

Done

@jpe442 jpe442 force-pushed the pgd/consistency/DOCS-287 branch from 418bc59 to 416ada3 Compare July 1, 2024 13:43
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 July 1, 2024 13:50 Inactive
gvasquezvargas
gvasquezvargas reviewed Jul 1, 2024
View reviewed changes
Copy link
Contributor

@gvasquezvargas gvasquezvargas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 for breaking up that huge topic!
I think some links are not working after the reorg, I tried to add what I thought would be the correct link, but I was not always 100% sure.

product_docs/docs/pgd/5/consistency/conflicts/01_types_of_conflict.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/01_types_of_conflict.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/01_types_of_conflict.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/01_types_of_conflict.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/01_types_of_conflict.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/03_conflict_detection.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/03_conflict_detection.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/03_conflict_detection.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/index.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/index.mdx Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 July 2, 2024 17:29 Inactive
@jpe442 jpe442 force-pushed the pgd/consistency/DOCS-287 branch from 410f307 to 004b5a9 Compare July 2, 2024 17:30
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 July 2, 2024 17:46 Inactive
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 July 2, 2024 18:22 Inactive
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 July 2, 2024 18:31 Inactive
gvasquezvargas
gvasquezvargas approved these changes Jul 3, 2024
View reviewed changes
Copy link
Contributor

@gvasquezvargas gvasquezvargas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny comment, everything else LGTM!

@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 July 3, 2024 13:42 Inactive
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 July 3, 2024 15:33 Inactive
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 July 3, 2024 16:45 Inactive
@djw-m
Copy link
Contributor

djw-m commented Jul 3, 2024

The links in the main text to conflict functions are broken (they go to the conflicts lists page where there's no matching anchor).

@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 July 3, 2024 17:23 Inactive
@jpe442 jpe442 requested a review from djw-m July 3, 2024 23:29
djw-m
djw-m approved these changes Jul 9, 2024
View reviewed changes
Copy link
Contributor

@djw-m djw-m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of notes, but LGTM

product_docs/docs/pgd/5/consistency/conflicts/00_conflicts_overview.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/01_avoid_tolerate_conflicts.mdx Outdated Show resolved Hide resolved
product_docs/docs/pgd/5/consistency/conflicts/index.mdx Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to pr-5804-pgd-consistency-docs-287 July 9, 2024 18:06 Inactive
@jpe442 jpe442 merged commit 5b801fa into develop Jul 9, 2024
1 check passed
@jpe442 jpe442 deleted the pgd/consistency/DOCS-287 branch July 9, 2024 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@djw-m djw-m djw-m approved these changes

@gvasquezvargas gvasquezvargas gvasquezvargas approved these changes

@piano35-edb piano35-edb Awaiting requested review from piano35-edb

@dwicinas dwicinas Awaiting requested review from dwicinas

@nidhibhammar nidhibhammar Awaiting requested review from nidhibhammar

Assignees
No one assigned
Labels
deploy Add this label to a PR and it will automatically be deployed to netlify
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jpe442 @djw-m @gvasquezvargas