tarantool / tarantool/doc

Make vinyl experimental

Open
#3,523 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

epic restructure vinyl
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Движок vinyl получил статус Экспериментального.

В связи с этим в документации необходимо:

  • Добавить в документацию отдельную страницу со списком экспериментальных технологий и пояснения, что именно значит этот статус
  • Занести vinyl в список экспериментальных технологий
  • Везде в документации, где сейчас встречается vinyl, сделать отметку о том, что это экспериментальная технология и дать ссылку на страницу про экспериментальные технологии
  • Сделать перевод на русский этого нового контента, в первую очередь страницы про экспериментальные технологии

Экспериментальные технологии:

  • не рекомендуется использовать на production
  • документация на экспериментальные технологии не развивается и может не отражать реальную работу экспериментальной технологии
  • поддержка экспериментальных технологий не оказывается
  • команда не берет на себя никаких обязательство по исправлению ошибок, в том числе критических, в экспериментальных технологиях
  • модули, а также инструменты, могут не поддерживать работу с экспериментальными технологиями

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

Search the documentation for every occurrence of vinyl and identify the existing technology-list and translation structures. Create the experimental-technologies page and its Russian translation, then mark each vinyl reference with a link and confirm all checklist items are covered.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.