[DOCS-8379] Change Format of Sharding Headings Created: 19/Jul/16 Updated: 30/Oct/23 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | manual, Server |
| Affects Version/s: | None |
| Fix Version/s: | Server_Docs_20231030 |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | Danny Hatcher (Inactive) | Assignee: | Kay Kim (Inactive) |
| Resolution: | Won't Do | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Participants: | |
| Days since reply: | 1 year, 14 weeks, 2 days ago |
| Epic Link: | DOCSP-1769 |
| Description |
|
In 3.0, the Sharding page is organized with an Introduction, a grouping of Concepts, a grouping of Tutorials, and Reference pages. This is a clean format that is easy to read and makes it easy to find information. However, in 3.2 the documentation shifted its formatting for this section. It still has the Reference but it now has groupings of various concepts at the top-level plus a grouping of Administration. The Administration section contains a lot of different instruction pages but it could be a little daunting to someone just trying to enable sharding for the first time and looking for simple step-by-step instructions. 3.2 Replication includes a Tutorial section formatted like 3.0 Sharding. I am requesting implementing a similar style to the 3.0 format for the Sharding section with a distinct Tutorials page and subsections within those tutorial pages that specify things like "Deployment", "Maintenance", and "Data Management" in order to make it easier for users to first use sharding with MongoDB. |
| Comments |
| Comment by Education Bot [ 31/Oct/22 ] |
|
Hello! This ticket has been closed due to inactivity. If you believe this ticket is still important, please reopen it and leave a comment to explain why. Thank you! |
| Comment by Sam Kleinman (Inactive) [ 21/Jul/16 ] |
|
I don't know what the right approach here is, and I don't want to dictate an implementation, but I was looking for a specific piece of information in the docs (related to secondaryThrottle) and I had a hell of a time finding this documentation. Now to be fair, I know the docs content really well so my discovery process is hard to optimize for, so I would suggest the following:
|