tarantool / tarantool/doc

[8pt] Add instructions on how to operate with RPM / Deb packages

Open
#1,279 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Add instructions on how to operate with RPM / Deb packages

Product: Tarantool
Since: all
Audience/target: admins
Root document:

SME: @Totktonada, @Mons, other Tarantool admins
Peer reviewer: @

Details

After #1218 we'll provide RPM / Deb repositories for release packages in addition to per-push 'live' repositories we have now.

The documentation should answer the following questions:

  • how to stick with certain tarantool version or version range;
  • how to update from a release version to one with necessary bugfix ('live' one);
  • how to move from a live version to the next release when it will be published.
  • @Mons also points out that the instructions should clarify how to roll back an update if something is going wrong.

Are there other actions that should be described for a user? -- TBD: ask Tarantool admins what they really need in this regard.

Source: https://lists.tarantool.org/pipermail/tarantool-patches/2020-January/013736.html

Definition of done

  • Installation and update instructions for the cases mentioned in Details are written.
  • https://www.tarantool.io/en/download/ page contains clear indications of where to find the instructions for all the cases needed.

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 /en/download/ and /en/doc/latest/book/admin/ pages and review the linked January 2020 mailing-list discussion. Ask the listed Tarantool admins what package actions need coverage, then document version pinning, release/live updates, rollbacks, and transitions between them. Done means the installation and update cases are documented and the download page clearly links to them.

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
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.