tarantool / tarantool/doc

ATE: update naming for Tarantool-based configuration storage

Open
#5,506 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ate terminology
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Related dev. issue(s):
Product: ATE
Audience/target: all
Root document: https://www.tarantool.io/docs/ate/
SME: @ veod32 @ lenkis @ lastoCHka42

Details

В доке АТЕ нужно привести к единому виду нейминг хранилища конфига на основе Tarantool.
Сейчас там встречается вариант Tarantool Config Storage, от которого мы уходим, т.к. это внутренний сленговый вариант названия. Выбрали в качестве текущего варианта термин, который используется в платформенной документации: https://www.tarantool.io/en/doc/latest/platform/configuration/configuration_etcd/
И дополнительно ввели сокращение, которое будем использовать дальше в доке.

Т.е. сейчас с док-тим мы зафиксировали такие промежуточные варианты термина:

  • для EN доки: "Tarantool-based configuration storage"
  • для RU доки: "централизованное хранилище конфигурации на основе Tarantool (Tarantool-based configuration storage, далее – TBCS)".
    Эти варианты будем использовать до тех пор, пока не появится другая формулировка термина или не поменяется название компонента.
    Пока не уверена, где в доке ATE написать полный термин в качестве первого вхождения, у нас там как будто нет подходящего места под это, но подумаю, посмотрю. Как вариант - можно в нескольких местах главах, при первом упоминании термина в этой главе

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the ATE root document and search its English and Russian pages for “Tarantool Config Storage” and other names for the Tarantool-based configuration storage. Update the terminology consistently using the specified English and Russian forms, then verify that the old internal wording no longer appears in the ATE documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.