Skip to content

Conversation

@xuniq
Copy link
Contributor

@xuniq xuniq commented Oct 4, 2024

Staging:

  • Added replicaset_name description
  • Renamed cluster to replicaset_uuid
  • Added note about max_id deprecation
  • Updated box.once() description

Fixes #3409
Fixes #3464

  • Add note about max_id deprecation to 2.11 branch

@xuniq xuniq changed the title Update the description of _schema system space Update the description of box.space._schema Oct 4, 2024
@xuniq xuniq force-pushed the gh-3464-replicaset_uuid branch from e1af39e to d1234f5 Compare October 10, 2024 09:28
@xuniq xuniq requested a review from Gerold103 October 10, 2024 09:28
Copy link
Contributor

@Gerold103 Gerold103 left a comment

Choose a reason for hiding this comment

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

Thanks! Our doc team is amazing btw, don't often get a chance to review stuff from you, guys.

.. code-block:: console
tarantool> box.space._schema:delete('oncehello')
app:instance001> box.space._schema:delete('oncehello')
Copy link
Contributor

Choose a reason for hiding this comment

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

I am not reviewing doc patches often, so I might be out of the context. Is it common for us to write the instance name like this now? Or is tarantool> more canonical?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the review!

We wrote the tarantool> prefix (and a few other variants) before version 3.0. In Tarantool 3.x, when connecting to an instance, the prefix is ​​displayed in the application_name:instance_name> format. It seems correct to write it this way: the users see this format in the docs, and they see the same format in the terminal (usage example: what's new 3.2.0). This way became widespread when executable examples appeared in the 3.x docs (example: GS). In these examples, the application_name:instance_name format makes it easier for the user to follow the guide steps.

Copy link
Contributor

Choose a reason for hiding this comment

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

tarantool -i prompts with tarantool>.

{tarantoolctl,cartridge,tt} connect <..uri..> prompts with something like uri>.

cartridge enter,tt connect} <..instance name..> prompts with someting like instance name>. AFAIR, app:name is tt's (and cartridge-cli's) instance name format.

So developers likely frequently see tarantool>, but users likely see instance name> more often.

@xuniq xuniq requested a review from lenkis October 10, 2024 17:04
@xuniq
Copy link
Contributor Author

xuniq commented Oct 11, 2024

Added info about max_id deprecation to 2.11 branch: #4599

xuniq and others added 2 commits October 11, 2024 12:56
Co-authored-by: Elena Shebunyaeva <elena.shebunyaeva@gmail.com>
@xuniq xuniq merged commit f58bb6f into latest Oct 11, 2024
1 check passed
@xuniq xuniq deleted the gh-3464-replicaset_uuid branch October 11, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename cluster key to replicaset_uuid key in _schema system space Update the description of _schema

5 participants