[DOCS-3840] OnPrem Docs Navigation Menu Reorg Created: 29/Jul/14  Updated: 16/Mar/15  Resolved: 11/Sep/14

Status: Closed
Project: Documentation
Component/s: Cloud Manager
Affects Version/s: None
Fix Version/s: v1.3.11

Type: Task Priority: Major - P3
Reporter: Rachelle Palmer Assignee: Sam Kleinman (Inactive)
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Sub-Tasks:
Key
Summary
Type
Status
Assignee
DOCS-3975 merge mms faq into one page Sub-task Closed Bob Grabar  
DOCS-3976 merge troubleshooting into one page Sub-task Closed Bob Grabar  
DOCS-3977 format high level mms overview Sub-task Closed Sam Kleinman  
DOCS-3978 reorg installing onprem mms section Sub-task Closed Sam Kleinman  
DOCS-3979 reorg content into using mms Sub-task Closed Kay Kim  
DOCS-3980 on prem administration section Sub-task Closed Sam Kleinman  
DOCS-3981 promote security overview to top leve... Sub-task Closed Kay Kim  
DOCS-4027 api section to top level Sub-task Closed Kay Kim  
DOCS-4028 fix build errors Sub-task Closed Kay Kim  
Participants:
Days since reply: 9 years, 22 weeks, 6 days ago

 Description   

New Structure (for example, not all inclusive. will need to in detail make sure all pages go in their proper places)

1.MMS Application Overview
(this is a high level landing page - no one reads this!)

  • What it is
  • How Monitoring Works
  • How Backup Works

2. Installing MMS Server (click this should take you to the Components page)

  • Components
  • Hardware Requirements / Sizing
  • QuickStart Guide (single server)
  • Install application (MMS + Backup)
    • Tarball
    • RPM
  • Configurable MMS Global Settings
    • Email (SMTP/SES)
    • SMS (Twilio)
    • Database authentication (MONGODB-CR/None/Kerberos/Encrypted Credentials/LDAP)
    • User authentication (MMS local authentication/LDAP)
    • SSL
    • Password requirements
  • Production Deployment
    • HA ("pointer" to Admin section)
    • Multiple MMS Backup Blockstore Databases ("pointer" to Admin section)
  • Link to reference pages for architecture diagrams

3. Using MMS (this is a user guide)

  • Browsers Supported
  • Create a group
  • Monitoring Agent (downloading RPM, installing RPM, putting in API key)
    • Installing
    • Configuring (security stuff)
  • Backup Agent
    • Installing
    • Configuring (security stuff)
  • Automation Agent (dont mention anything about automation for MMS Cloud: Classic)
    • Installing
    • Configuring (security stuff)
  • Adding hosts
  • Add users, assign roles
  • Setting up Alerts
  • Host mapping stuff
  • Interpreting MMS Metrics
  • How to use Backup/Restore
    • Backing up a replica set
    • Backing up a sharded cluster
    • Restore a replica set
    • Restore a sharded cluster

4. Administration (OnPrem only)

  • Binding Jobs
  • Grooms
  • User administration
  • HA
  • Multiple MMS Backup Blockstore Databases

5. Security (largely cross references to the install stuff with some high level content)

  • Overview of different security features and what they affect
  • LDAP (pointer to everywhere we have talked about LDAP with nice words wrapping it)
  • Kerberos (see above)
  • SSL stuff (see above)
  • Connecting to the internet via HTTP proxy

6. Troubleshooting (one long page broken into sections)

  • Installation troubleshooting
  • Monitoring troubleshooting
  • Backup troubleshooting

7. API

8. Reference

  • Glossary
  • Metrics Definitions
  • Architecture Diagrams

9. FAQ (one long page broken into sections)

  • Deployment FAQ
  • Alerts & Metrics FAQ
  • Backup FAQ

10. Release Notes



 Comments   
Comment by Sam Kleinman (Inactive) [ 11/Sep/14 ]

closing this, as the only parts left are redirects and merging.

Comment by Githook User [ 03/Sep/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-3840: initial admin/user guide change
Branch: next
https://github.com/10gen/mms-docs/commit/dabab9639079aacaec29219768aa1df8e3db301b

Comment by Githook User [ 02/Sep/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-3840: initial admin/user guide change
Branch: next
https://github.com/10gen/mms-docs/commit/1ed3b618cb54c0553a0e1565998f7b624fa7af58

Comment by Githook User [ 02/Sep/14 ]

Author:

{u'username': u'tychoish', u'name': u'Sam Kleinman', u'email': u'samk@10gen.com'}

Message: DOCS-3840: initial admin/user guide change
Branch: master
https://github.com/10gen/mms-docs/commit/1ed3b618cb54c0553a0e1565998f7b624fa7af58

Generated at Thu Feb 08 07:46:37 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.