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

Revise configuration-related docs #1082

Closed
wants to merge 21 commits into from
Closed

Conversation

josh-wong
Copy link
Member

@josh-wong josh-wong commented Sep 12, 2023

Description

This PR revises configuration-related documents.

Related issues and/or PRs

N/A

Changes made

  • Revised contents.
  • Added notice blocks for noteworthy content.
  • Added content tabs for databases (in configurations.md).
  • Added Mermaid code for some diagrams (in configurations.md).

Branches this PR applies to

Note

The configurations.md doc includes mentions of ScalarDB Server, which I don't think we should include in branches 3.10 and 3.9. We'll need to make a separate PR to address the differences between including ScalarDB Server in 3.8 to 3.5 and not including ScalarDB Server in 3.9, 3.10, and master.

  • master
  • 3.8
  • 3.7
  • 3.6
  • 3.5

Testing done

I ran our docs site locally with these changes and confirmed that these revised docs, including content tabs, notice blocks, images, Mermaid diagrams, and formatting, appeared as expected. Attached are three screenshots for each doc in this PR.

The following screenshot shows configurations.md:

configurations

The following screenshot shows two-phase-commit-transactions.md:

two-phase-commit-transactions

The following screenshot shows multi-storage-transactions.md:

multi-storage-transactions

Checklist

  • I have commented my code, particularly in hard-to-understand areas.
  • The documentation has been updated to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • Tests (unit, integration, etc.) have been added for the changes.
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

Please see my comments in the revised files.

@josh-wong josh-wong self-assigned this Sep 12, 2023
docs/configurations.md Outdated Show resolved Hide resolved
docs/configurations.md Outdated Show resolved Hide resolved
docs/configurations.md Outdated Show resolved Hide resolved
@josh-wong josh-wong marked this pull request as ready for review September 12, 2023 08:15
Copy link
Contributor

@komamitsu komamitsu left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

docs/multi-storage-transactions.md Outdated Show resolved Hide resolved
docs/configurations.md Outdated Show resolved Hide resolved
docs/configurations.md Outdated Show resolved Hide resolved
docs/configurations.md Outdated Show resolved Hide resolved
docs/configurations.md Outdated Show resolved Hide resolved
docs/configurations.md Outdated Show resolved Hide resolved
Change mentions of "transactions" (relating to Consensus Commit and gRPC) to "transaction managers".
Copy link

@choplin choplin left a comment

Choose a reason for hiding this comment

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

LGTM!

docs/configurations.md Show resolved Hide resolved
docs/configurations.md Show resolved Hide resolved
@josh-wong josh-wong changed the base branch from master to 3.8 September 27, 2023 06:55
@josh-wong josh-wong changed the base branch from 3.8 to master September 27, 2023 08:51
[skip ci]

Change `two-phase commit transactions` to `transactions with a two-phase commit interface` as noted in #934 (comment).
@josh-wong
Copy link
Member Author

As discussed with @feeblefakie, I will be closing this PR and creating a new PR that includes the changes to these docs and targets branch 3.8.

I mistakenly used the docs from the master branch and therefore cannot easily merge the changes by simply switching the target branch since there are many other upstream changes that are irrelevant to branches 3.8 and earlier that would be applied🙇🏻‍♂️

@josh-wong josh-wong closed this Sep 27, 2023
josh-wong added a commit that referenced this pull request Sep 27, 2023
The contents of this file matches the contents of the same file in a previous PR.

Ref: #1082
josh-wong added a commit that referenced this pull request Sep 27, 2023
[skip ci]
The contents of this file matches the contents of the same file in a previous PR.

Ref: #1082
@brfrn169 brfrn169 deleted the revise-configuration-docs branch October 12, 2023 06:38
josh-wong added a commit that referenced this pull request Oct 12, 2023
[skip ci]

Update doc based on changes and comments in the following PRs: #1117 and #1082.
josh-wong added a commit that referenced this pull request Oct 12, 2023
[skip ci]

Update doc based on changes and comments in the following PRs: #1117 and #1082.
josh-wong added a commit that referenced this pull request Oct 12, 2023
Update doc based on changes and comments in the following PRs: #1117 and #1082.
josh-wong added a commit that referenced this pull request Oct 12, 2023
[skip ci]

Update doc based on changes and comments in the following PRs: #1117 and #1082.
josh-wong added a commit that referenced this pull request Oct 16, 2023
[skip ci]

Update doc based on changes and comments in the following PRs: #1117 and #1082.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants