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

Revise the contents of the Java API guide #1084

Merged
merged 19 commits into from
Oct 3, 2023
Merged

Revise the contents of the Java API guide #1084

merged 19 commits into from
Oct 3, 2023
+417 −324

Conversation

josh-wong
Copy link
Member

@josh-wong josh-wong commented Sep 15, 2023 •
edited
Loading

Description

This PR revises the contents of the ScalarDB Java API Guide, mostly from an editorial perspective.

Related issues and/or PRs

Related to #1082 (some similarities in content)

Changes made

  • Revised content.
  • Added notice blocks for noteworthy content.
  • Added content tabs for databases.

Branches this PR applies to

  • master

Note

After this PR is approved and merged, I will create another PR for branches 3.10, 3.9, 3.8, 3.7, and 3.6 that removes the Get existing namespaces section, which doesn't apply to those branches.

Testing done

I ran our docs site locally with these changes and confirmed that these revised docs, including content tabs, notice blocks, and formatting, appeared as expected. Attached is a screenshot of the api-guide.md doc as it appears on the docs site.

The following screenshot shows api-guide.md:

API guide

Checklist

  • 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)

Please see my comments in the revised files.

@josh-wong josh-wong self-assigned this Sep 15, 2023
josh-wong
josh-wong commented Sep 15, 2023
View reviewed changes
docs/api-guide.md Outdated Show resolved Hide resolved
josh-wong
josh-wong commented Sep 15, 2023
View reviewed changes
docs/api-guide.md Outdated Show resolved Hide resolved
josh-wong
josh-wong commented Sep 15, 2023
View reviewed changes
docs/api-guide.md Outdated Show resolved Hide resolved
@josh-wong josh-wong marked this pull request as ready for review September 15, 2023 07:40
@josh-wong
Fix mentions of transactions to transaction managers
8fb8409 
Change "Consensus Commit transactions" to "Consensus Commit transaction manager."
komamitsu
komamitsu reviewed Sep 19, 2023
View reviewed changes
docs/api-guide.md Outdated Show resolved Hide resolved
komamitsu
komamitsu reviewed Sep 19, 2023
View reviewed changes
docs/api-guide.md Outdated Show resolved Hide resolved
choplin
choplin reviewed Sep 20, 2023
View reviewed changes
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.

Nice work! It looks much better, especially the section explaining exception handling.

I left several comments, PTAL!

docs/api-guide.md Show resolved Hide resolved
docs/api-guide.md Show resolved Hide resolved
docs/api-guide.md Show resolved Hide resolved
docs/api-guide.md Outdated Show resolved Hide resolved
docs/api-guide.md Outdated Show resolved Hide resolved
docs/api-guide.md Outdated Show resolved Hide resolved
docs/api-guide.md Outdated Show resolved Hide resolved
docs/api-guide.md Outdated Show resolved Hide resolved
Torch3333
Torch3333 reviewed Sep 21, 2023
View reviewed changes
Copy link
Contributor

@Torch3333 Torch3333 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Overall, it looks good, thank you. I have two minor comments.

docs/api-guide.md Outdated Show resolved Hide resolved
docs/api-guide.md Outdated Show resolved Hide resolved
josh-wong and others added 2 commits September 21, 2023 17:25
@josh-wong @Torch3333
Fix wrong word (change "with" to "without")
945d04a 
Co-authored-by: Vincent Guilpain <vincent.guilpain@scalar-labs.com>
@josh-wong
Fix grammar in heading
8a17f84
@josh-wong josh-wong requested a review from Torch3333 September 21, 2023 08:29
Torch3333
Torch3333 approved these changes Sep 22, 2023
View reviewed changes
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.

LGTM, thank you!

komamitsu
komamitsu approved these changes Sep 26, 2023
View reviewed changes
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, thank you!

@josh-wong josh-wong requested a review from feeblefakie October 3, 2023 09:35
feeblefakie
feeblefakie approved these changes Oct 3, 2023
View reviewed changes
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 380d9a9 into master Oct 3, 2023
@feeblefakie feeblefakie deleted the docs/revise-api-guide branch October 3, 2023 23:49
@josh-wong josh-wong changed the title Revise the contents of the Java API guide Revise the contents of the Java API guide (master) Oct 4, 2023
josh-wong added a commit that referenced this pull request Oct 11, 2023
@josh-wong
Update doc
17eef9e 
[skip ci]

Update doc based on changes and comments in the following PR: #1084.
josh-wong added a commit that referenced this pull request Oct 11, 2023
@josh-wong
Update explanation
95320f3 
[skip ci]

Update explanation based on changes and comments in the following PR: #1084.
josh-wong added a commit that referenced this pull request Oct 11, 2023
@josh-wong
Update explanation
99cc18a 
[skip ci]

Update explanation based on changes and comments in the following PR: #1084.
josh-wong added a commit that referenced this pull request Oct 11, 2023
@josh-wong
Update doc
ad9d954 
[skip ci]

Update doc based on changes and comments in the following PR: #1084.
josh-wong added a commit that referenced this pull request Oct 11, 2023
@josh-wong
Update explanation
d2409a5 
[skip ci]

Update explanation based on changes and comments in the following PR: #1084.
josh-wong added a commit that referenced this pull request Oct 11, 2023
@josh-wong
Update doc
7c11f25 
[skip ci]

Update doc based on changes and comments in the following PR: #1084.
josh-wong added a commit that referenced this pull request Oct 11, 2023
@josh-wong
Update explanation
d2b404b 
[skip ci]

Update explanation based on changes and comments in the following PR: #1084.
josh-wong added a commit that referenced this pull request Oct 11, 2023
@josh-wong
Update doc
669ab0a 
[skip ci]

Update doc based on changes and comments in the following PR: #1084.
josh-wong added a commit that referenced this pull request Oct 11, 2023
@josh-wong
Update doc
a632862 
[skip ci]

Update doc based on changes and comments in the following PR: #1084.
This was referenced Oct 11, 2023
Merged
Merged
Merged
Merged
Merged
@josh-wong josh-wong changed the title Revise the contents of the Java API guide (master) Revise the contents of the Java API guide Oct 11, 2023
This was referenced Oct 12, 2023
Merged
Merged
Merged
Merged
Merged
Merged
Merged
josh-wong added a commit that referenced this pull request Oct 16, 2023
@josh-wong
Update doc
82c4990 
Update doc based on changes and comments in the following PRs: #1084 and #1117.
@josh-wong josh-wong mentioned this pull request Oct 16, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Torch3333 Torch3333 Torch3333 approved these changes

@brfrn169 brfrn169 brfrn169 approved these changes

@feeblefakie feeblefakie feeblefakie approved these changes

@komamitsu komamitsu komamitsu approved these changes

@choplin choplin Awaiting requested review from choplin

Assignees

@josh-wong josh-wong

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@josh-wong @komamitsu @brfrn169 @choplin @feeblefakie @Torch3333