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 (3.8) #1117

Merged
merged 20 commits into from
Oct 11, 2023
Merged

Conversation

josh-wong
Copy link
Member

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

Description

This PR revises configuration-related documents.

Note

This PR targets ScalarDB 3.8 to 3.5 and incorporates the feedback in the original PR: #1082

A new PR is needed for reasons mentioned in my comment in the previous PR.

Related issues and/or PRs

#1082

Changes made

This PR includes the same changes that were addressed in #1082:

  • 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).
  • Deleted configurations-for-consensus-commit.md since its contents were previously combined with configurations.md.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation 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)

N/A

Release notes

N/A

Delete `configurations-for-consensus-commit.md` since its contents have been combined with `configurations.md`.
The contents of this file matches the contents of the same file in a previous PR.

Ref: #1082
[skip ci]
The contents of this file matches the contents of the same file in a previous PR.

Ref: #1082
@josh-wong josh-wong self-assigned this Sep 27, 2023
@josh-wong josh-wong changed the title Revise configuration-related docs (branch 3.8 and earlier) Revise configuration-related docs (3.8 and earlier) Sep 27, 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
docs/configurations.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Torch3333 Torch3333 left a comment

Choose a reason for hiding this comment

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

Thank you for backporting the changes to these docs. It's pretty tricky to keep track of the feature getting deprecated or appearing.

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 Show resolved Hide resolved
docs/configurations.md Show resolved Hide resolved
docs/two-phase-commit-transactions.md Outdated Show resolved Hide resolved
docs/two-phase-commit-transactions.md Show resolved Hide resolved
docs/two-phase-commit-transactions.md Outdated Show resolved Hide resolved
docs/two-phase-commit-transactions.md Outdated Show resolved Hide resolved
docs/configurations.md Outdated Show resolved Hide resolved
josh-wong and others added 8 commits September 29, 2023 14:54
[skip ci]
This section only applies to version branch `4.0`.

Co-authored-by: Vincent Guilpain <vincent.guilpain@scalar-labs.com>
[skip ci]
This section only applies to version branch `4.0`.

Co-authored-by: Vincent Guilpain <vincent.guilpain@scalar-labs.com>
[skip ci]

Co-authored-by: Vincent Guilpain <vincent.guilpain@scalar-labs.com>
[skip ci]

Co-authored-by: Vincent Guilpain <vincent.guilpain@scalar-labs.com>
[skip ci]

Co-authored-by: Vincent Guilpain <vincent.guilpain@scalar-labs.com>
[skip ci]
Remove notice about SQLite3 since it's not supported in 3.8 and earlier.
Copy link
Member Author

@josh-wong josh-wong left a comment

Choose a reason for hiding this comment

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

@Torch3333 Thank you for your comments!🙏 I've incorporated many of your comments and will incorporate the rest when backporting PRs to earlier branches.

docs/multi-storage-transactions.md Show resolved Hide resolved
docs/two-phase-commit-transactions.md Outdated Show resolved Hide resolved
docs/two-phase-commit-transactions.md Outdated Show resolved Hide resolved
docs/two-phase-commit-transactions.md Outdated Show resolved Hide resolved
docs/multi-storage-transactions.md Show resolved Hide resolved
docs/configurations.md Show resolved Hide resolved
docs/configurations.md Show resolved Hide resolved
docs/configurations.md Outdated Show resolved Hide resolved
docs/configurations.md Show resolved Hide resolved
docs/configurations.md Show resolved Hide resolved
[skip ci]
Change `transactionManager` to `manager` for 3.8 and earlier. `manager` was changed to `transactionManager` in 3.9.
docs/configurations.md Outdated Show resolved Hide resolved
docs/configurations.md Outdated Show resolved Hide resolved
[skip ci]
docs/configurations.md Outdated Show resolved Hide resolved
[skip ci]
Copy link
Contributor

@feeblefakie feeblefakie left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

@feeblefakie feeblefakie merged commit 223cb10 into 3.8 Oct 11, 2023
@feeblefakie feeblefakie deleted the revise-configuration-docs-3.8 branch October 11, 2023 23:26
@josh-wong josh-wong changed the title Revise configuration-related docs (3.8 and earlier) Revise configuration-related docs (3.8) Oct 12, 2023
josh-wong added a commit that referenced this pull request Oct 12, 2023
Update doc based on changes and comments in the following PR: #1117.
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 PR: #1117.
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 12, 2023
Update doc based on changes and comments in the following PR: #1117.
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 PR: #1117.
josh-wong added a commit that referenced this pull request Oct 12, 2023
Update doc based on changes and comments in the following PR: #1117.
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 PR: #1117.
josh-wong added a commit that referenced this pull request Oct 12, 2023
Update doc based on changes and comments in the following PR: #1117.
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 PR: #1117.
josh-wong added a commit that referenced this pull request Oct 16, 2023
Update doc based on changes and comments in the following PRs: #1084 and #1117.
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.

4 participants