Skip to content

Commit 2382be5

Browse files
committed
Add info re LSP YAML server to Basic config section
1 parent 86467b0 commit 2382be5

File tree

4 files changed

+21
-2
lines changed

4 files changed

+21
-2
lines changed

doc/code_snippets/snippets/config/instances.enabled/instance_scope/config.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# yaml-language-server: $schema=https://download.tarantool.org/tarantool/schema/config.schema.json
21
groups:
32
group001:
43
replicasets:
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# yaml-language-server: $schema=https://download.tarantool.org/tarantool/schema/config.schema.json
2+
3+
groups:
4+
group001:
5+
replicasets:
6+
replicaset001:
7+
instances:
8+
instance001:
9+
iproto:
10+
listen:
11+
- uri: '127.0.0.1:3301'

doc/platform/configuration.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Basic instance configuration
7777

7878
The example below shows a sample configuration of a single Tarantool instance:
7979

80-
.. literalinclude:: /code_snippets/snippets/config/instances.enabled/instance_scope/config.yaml
80+
.. literalinclude:: /code_snippets/snippets/config/instances.enabled/instance_scope/config_annotated.yaml
8181
:language: yaml
8282
:dedent:
8383

@@ -86,6 +86,15 @@ The example below shows a sample configuration of a single Tarantool instance:
8686
- The ``replicasets`` section contains one replica set named *replicaset001*.
8787
- The ``groups`` section contains one group named *group001*.
8888

89+
.. note:
90+
91+
The initial line in this sample contains a link to an annotated Tarantool configuration
92+
schema for a YAML language server (e.g. for `LSP-Yaml`).
93+
With this link you can set up your code editor (VScode, Neovim, Sublime, etc.) to get
94+
full-text annotations and completion prompts when you work with Tarantool configuration.
95+
96+
.. image:: images/yaml-annotated.png
97+
:align: center
8998

9099
.. _configuration_scopes:
91100

192 KB
Loading

0 commit comments

Comments
 (0)