Update tt commands descriptions to 2.1.2 #4039
Conversation
p7nov
force-pushed
the
gh-3999-tt-2-0-commands-update
branch
from
f7ac385 to
c8d3d46
Compare
Co-authored-by: Pavel Sergeev <[email protected]>
|
|
||
| * Start only the ``master`` instance of the application stored in the ``app/`` directory inside ``instances_enabled``: | ||
| ``tt start`` can start single Tarantool instances without cluster configurations. |
There was a problem hiding this comment.
without cluster configurations
I'd clarify this description with a link to the Configuration in code topic:
https://www.tarantool.io/en/doc/latest/concepts/configuration/configuration_code/
Now it is hard to understand that this instruction is for a legacy approach. `
|
|
||
| ``tt stop`` stops the specified running Tarantool instances. | ||
| ``tt stop`` stops the specified running Tarantool applications or instances. | ||
| When called without arguments, stops all running applications in the current environment. |
There was a problem hiding this comment.
I'd add a link to tt start somewhere to allow a reader get more context. (Here and in other pages related to starting/stopping instances - status/restart/...)
|
|
||
| You can combine different ways of passing variables in a single call of ``tt create``. | ||
|
|
||
| Application directory | ||
| ~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| By default, the application will appear in the directory named after the provided | ||
| By default, the application appears in the directory named after the provided | ||
| application name (``--name`` value). | ||
|
|
||
| To change the application location, use the ``-dst`` flag. |
There was a problem hiding this comment.
Let's add a link to the dst flag. (and maybe change flag -> option :) )
There was a problem hiding this comment.
Changed flag to option across the page.
Not sure we need links to options on the same page with their reference. There is a lot of such mentionings in usage explanation and we don't normally add links (on the same page).
| The application files must be stored inside the ``instances_enabled`` | ||
| directory specified in the :ref:`tt configuration file <tt-config_file_app>`. | ||
| The ``APPLICATION`` value can be: | ||
| Cluster application |
There was a problem hiding this comment.
As we discussed, let's consider restructuring of such pages to reflect that multi-instance apps can both use new and old config.
Co-authored-by: Andrey Aksenov <[email protected]>
|
|
||
| * Restart all instances of the application stored in the ``app/`` directory inside | ||
| ``instances_enabled`` in accordance with the :ref:`instances configuration <tt-instances>`: | ||
| * Restart only the ``master`` instance of the ``app`` application with automatic confirmation: |
There was a problem hiding this comment.
| * Restart only the ``master`` instance of the ``app`` application with automatic confirmation: | |
| * Restart only the ``master`` instance of the ``app`` application with automatic confirmation: |
Resolves #3999 https://github.com/tarantool/enterprise_doc/issues/260 https://github.com/tarantool/enterprise_doc/issues/259
Update descriptions in tt commands reference to new application concept of Tarantool 3.0:
FILE:SPACEfor import andSPACE:FILEfor export)vshard_clusterbuilt-in template in an example instead of outdatedcartridgeDeployment: https://docs.d.tarantool.io/en/doc/gh-3999-tt-2-0-commands-update/reference/tooling/tt_cli/commands/