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

glossary: Add more abbreviations #19213

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open

glossary: Add more abbreviations #19213

wants to merge 22 commits into from
+202 −22

Conversation

dveeden
Copy link
Contributor

@dveeden dveeden commented Oct 25, 2024

What is changed, added or deleted? (Required)

Closes #19212

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 25, 2024
@dveeden
Copy link
Contributor Author

dveeden commented Oct 28, 2024

@qiancai what about the HTTP 403 in the linkChecker? Is that ok?

@qiancai
Copy link
Collaborator

qiancai commented Oct 28, 2024

@qiancai what about the HTTP 403 in the linkChecker? Is that ok?

The linkChecker sometimes reports false errors due to network connectivity issues😂. I checked https://www.gartner.com/en/information-technology/glossary/htap-enabling-memory-computing-technologies and found it is accessible, so we can ignore the HTTP 403 error there.

@qiancai qiancai self-assigned this Oct 28, 2024
mjonss
mjonss reviewed Oct 29, 2024
View reviewed changes
glossary.md Outdated Show resolved Hide resolved
mjonss
mjonss reviewed Oct 29, 2024
View reviewed changes
glossary.md Outdated Show resolved Hide resolved
mjonss
mjonss reviewed Oct 29, 2024
View reviewed changes
glossary.md Outdated Show resolved Hide resolved
@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Oct 29, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

mjonss
mjonss approved these changes Oct 29, 2024
View reviewed changes
Copy link
Contributor

@mjonss mjonss left a comment

Choose a reason for hiding this comment

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

LGTM, with some suggestions.

glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Oct 29, 2024

@mjonss: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

LGTM, with some suggestions.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

dveeden and others added 3 commits October 29, 2024 11:49
@qiancai
Copy link
Collaborator

qiancai commented Nov 1, 2024

Hi @dveeden thanks for creating this PR. I've submitted bd23974 (#19213) as editorial comments. PTAL. Thanks.

@qiancai qiancai added type/enhancement The issue or PR belongs to an enhancement. translation/doing This PR's assignee is translating this PR. labels Nov 1, 2024
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Nov 1, 2024
qiancai
qiancai reviewed Nov 1, 2024
View reviewed changes
glossary.md Outdated Show resolved Hide resolved
@dveeden
Copy link
Contributor Author

dveeden commented Nov 1, 2024 •
edited
Loading

Hi @dveeden thanks for creating this PR. I've submitted bd23974 (#19213) as editorial comments. PTAL. Thanks.

This is a great improvement. Thanks.

For DR the included link looks weird, why is that?

Looks like the linkChecker also doesn't like it:

 * [ERR] [file:///home/runner/work/docs/docs/dr-solution-introduction](file:///home/runner/work/docs/docs/dr-solution-introduction) | Failed: Cannot find file

benmeadowcroft
benmeadowcroft reviewed Nov 1, 2024
View reviewed changes
Copy link
Collaborator

@benmeadowcroft benmeadowcroft left a comment

Choose a reason for hiding this comment

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

As requested I have left my comments on the PR.
I really appreciate the effort to update these areas of the documentation, I made a few suggestions for your consideration.

glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md Outdated Show resolved Hide resolved
glossary.md

### URI

Uniform Resource Identifier (URI) is a standardized format for identifying a resource. For more information, see [Uniform Resource Identifier](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) on Wikipedia.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we want to include this definition in the glossary?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is because it is mentioned in our docs quite often. I would assume URI/URL could be considered common knowledge and left out. I'm fine with it either way.

$ git grep -cw URI | sed "s/:/\t/" | sort -k2 -r | head
ticdc/ticdc-sink-to-mysql.md	7
tidb-cloud/config-s3-and-gcs-access.md	6
tidb-cloud/changefeed-sink-to-cloud-storage.md	6
ticdc/ticdc-sink-to-kafka.md	6
dumpling-overview.md	6
br/br-pitr-manual.md	5
tiproxy/tiproxy-api.md	4
tidb-cloud/tidb-cloud-auditing.md	4
tidb-cloud/migrate-sql-shards.md	4
tidb-cloud/migrate-from-op-tidb.md	4

@dveeden
Copy link
Contributor Author

dveeden commented Nov 6, 2024

As requested I have left my comments on the PR. I really appreciate the effort to update these areas of the documentation, I made a few suggestions for your consideration.

Thanks. These are some really good suggestions.

@dveeden
Copy link
Contributor Author

dveeden commented Nov 6, 2024

I added a script to check this file

$ ./scripts/check-glossary.py 
Checking alphabetic sorting of glossary.md
result: OK

qiancai
qiancai approved these changes Nov 7, 2024
View reviewed changes
glossary.md Outdated Show resolved Hide resolved
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Nov 7, 2024
@ti-chi-bot ti-chi-bot
Copy link

ti-chi-bot bot commented Nov 7, 2024

[LGTM Timeline notifier]

Timeline:

  • 2024-11-07 06:25:32.544679053 +0000 UTC m=+1108645.383834596: ☑️ agreed by qiancai.

@qiancai
Copy link
Collaborator

qiancai commented Nov 7, 2024

/cc @benmeadowcroft

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mjonss mjonss mjonss approved these changes

@qiancai qiancai qiancai approved these changes

@benmeadowcroft benmeadowcroft Awaiting requested review from benmeadowcroft

Assignees

@qiancai qiancai

Labels
needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Expand TiDB glossary to include frequently used abbreviations and explanations
4 participants
@dveeden @qiancai @benmeadowcroft @mjonss