canonical / canonical/mongo-single-kernel-library

Update client connections guide

Open
#109 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
1
Forks
2
Avg merge
2d 23h
Merged PRs (30d)
22

Description

`docs/how-to/manage-client-connections.md`

This guide needs a general review and structural redesign. In particular:

- [ ] Decide whether to consistently use `data-integrator` or generic ``
- [ ] Significantly clarify instructions regarding sharded clusters - particularly with regards to users and relations (see [this comment](https://github.com/canonical/mongo-single-kernel-library/pull/95/files#r2401280579))
- [ ] Remove `## Internal operator user` section

Contributor guide

Open the contributing guide

Research direction

Review docs/how-to/manage-client-connections.md first, then read the referenced comment on PR 95 for the sharded-cluster context. Decide on consistent terminology, clarify users and relations for sharded clusters, and remove the Internal operator user section; the guide is done when its structure and instructions are coherent throughout.

Written by the indexing model from the issue text.

Assessment

Tech stack
mongodb
Domain
databases, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.