Skip to content

Clean up the Administration section #3177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
4 tasks
Tracked by #3175
patiencedaur opened this issue Oct 3, 2022 · 0 comments
Open
4 tasks
Tracked by #3175

Clean up the Administration section #3177

patiencedaur opened this issue Oct 3, 2022 · 0 comments
Labels
admin [area] Related to Admin guide restructure Related to the transfer of sections, text.

Comments

@patiencedaur
Copy link
Contributor

patiencedaur commented Oct 3, 2022

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
@patiencedaur patiencedaur changed the title Distinguish tools for admins and tools from devs Distinguish between admin tools and dev tools in the doc Oct 3, 2022
@patiencedaur patiencedaur added 3sp admin [area] Related to Admin guide labels Oct 3, 2022
@patiencedaur patiencedaur changed the title Distinguish between admin tools and dev tools in the doc Clean up the Administration section Oct 3, 2022
@patiencedaur patiencedaur added the restructure Related to the transfer of sections, text. label Oct 3, 2022
@TarantoolBot TarantoolBot removed the 3sp label Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
admin [area] Related to Admin guide restructure Related to the transfer of sections, text.
Projects
None yet
Development

No branches or pull requests

2 participants