Update docs for the 'box.info' module #4427
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was
linked to
issues
Aug 12, 2024
andreyaksenov
force-pushed
the
update-box-info
branch
10 times, most recently
from
746ed9c to
b03b944
Compare
andreyaksenov
force-pushed
the
update-box-info
branch
from
b03b944 to
8693fb8
Compare
andreyaksenov
changed the title
Totktonada
reviewed
Aug 13, 2024
andreyaksenov
force-pushed
the
update-box-info
branch
from
b952942 to
87ef2e6
Compare
andreyaksenov
force-pushed
the
update-box-info
branch
from
d50ce5a to
9359e95
Compare
Totktonada
reviewed
Aug 14, 2024
|
|
||
| .. data:: package | ||
|
|
||
| The package name. |
There was a problem hiding this comment.
Nit: We can say something like the following:
Currently there are
TarantoolandTarantool Enterprisepackages.
This way it is less abstract and a developer knows that it allows to distinguish CE/EE editions.
Totktonada
reviewed
Aug 14, 2024
|
|
||
| The package name. | ||
|
|
||
| See also: :ref:`tarantool --version <index-tarantool_version>` |
There was a problem hiding this comment.
Also reported from tarantool.package.
Totktonada
reviewed
Aug 14, 2024
|
|
||
| The Tarantool version. | ||
|
|
||
| See also: :ref:`tarantool --version <index-tarantool_version>` |
There was a problem hiding this comment.
Also reported from tarantool.version. See https://stackoverflow.com/a/65330537/1598057.
Totktonada
approved these changes
Aug 14, 2024
xuniq
approved these changes
Aug 15, 2024
| - The instance's state in regard to configuration | ||
|
|
||
| * - :doc:`./box_info/election` | ||
| - The current state of this replica set node in regards to leader election |
There was a problem hiding this comment.
Suggested change
| - The current state of this replica set node in regards to leader election | |
| - The current state of this replica set node in regard to leader election |
|
|
||
| Show the current state of a replica set node in regards to :ref:`leader election <repl_leader_elect>`. | ||
| The current state of this replica set node in regards to :ref:`leader election <repl_leader_elect>`. |
There was a problem hiding this comment.
Suggested change
| The current state of this replica set node in regards to :ref:`leader election <repl_leader_elect>`. | |
| The current state of this replica set node in regard to :ref:`leader election <repl_leader_elect>`. |
p7nov
added a commit
that referenced
this pull request
Oct 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the
box.infodocumentation to make its quality a bit better:box.infonow have their own pages.PR also includes updates introduced in v3.0.0 and later, for example, box.info.config, box.info.hostname. See the staging here: https://docs.d.tarantool.io/en/doc/update-box-info/reference/reference_lua/box_info/
Also some new
box.cfgoptions are documented (instance_name,replicaset_name,cluster_name): https://docs.d.tarantool.io/en/doc/update-box-info/reference/configuration/#replicationUPD: Specified the rules applied to names in the Configuration reference:
https://docs.d.tarantool.io/en/doc/update-box-info/reference/configuration/configuration_reference/#groups
They are the same as for new
box.cfgoptions.