tarantool / tarantool/doc

Clean up the Administration section

Open
#3,177 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Epic: Restructure Tarantool docs, stage 3

Root document: https://www.tarantool.io/en/doc/latest/book/admin/

Details

  • Clean up the Admin section as proposed below
  • Move the translations along with everything else
  • Add a link to the Tooling section in a relevant place
  • Create redirects (instruction)

Proposal for Admin section structure

This tree is TBD.

  • Installation and upgrade
    • Manage modules
    • Upgrades
    • Notes on operating systems
  • Configuration
    • Instance configuration
    • Security (rename, the name does not reflect article content)
    • Access control
    • Sharding with vshard
  • Monitoring
    • Logging
    • Server introspection
    • Daemon supervision
    • Monitoring with metrics (connect the /metrics module here)
    • Monitoring a replica set (move this from the "Replication administration" section)
  • Troubleshooting
    • Troubleshooting guide
    • Disaster recovery
    • Reseeding a replica (move this from the "Replication administration" section and discard the section)
    • Recovering from a degraded state (move this from the "Replication administration" section and discard the section)
    • Resolving replivation conflicts (move this from the "Replication administration" section and discard the section)
    • Bug reports

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 Administration root document and review the proposed structure in this issue, including the related stage 3 epic. Reorganize the Admin section, move its translations, add a relevant Tooling link, and create redirects; completion means all listed checklist items are addressed.

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.