DOCSP-38362 -- Add content to blank Ops Manager pages for SEO (#200)

jvincent-mongodb · corryroot · web-flow · commit 31237c929919 · 2024-06-03T13:12:52.000-07:00
Add content to blank Ops Manager pages for SEO - [DOCSP-number](https://jira.mongodb.org/browse/DOCSP-38362) - STAGING - https://preview-mongodbjvincentmongodb.gatsbyjs.io/ops-manager/DOCSP-38362/tutorial/nav/add-servers/ - https://preview-mongodbjvincentmongodb.gatsbyjs.io/ops-manager/DOCSP-38362/api/ - https://preview-mongodbjvincentmongodb.gatsbyjs.io/ops-manager/DOCSP-38362/tutorial/nav/monitor-and-manage/ - [LATEST BUILD LOG](https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=665e22bfcf5bec1c29103d5f) ### Self-Review Checklist - [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. - [ ] Add genre facets (tutorial or reference), as in this [example PR](10gen/cloud-docs#5042). - [ ] Add programmingLanguage (if necessary). - [ ] Add meta keywords (if necessary). - [ ] Resolve any new warnings or errors in the build. - [ ] Proofread for spelling and grammatical errors. - [ ] Check staging for rendering issues. - [ ] Confirm links are working. --------- Co-authored-by: corryroot <72401712+corryroot@users.noreply.github.com>
diff --git a/source/api.txt b/source/api.txt
@@ -10,6 +10,43 @@ API
    :depth: 1
    :class: singlecol
 
+The {+admin-api+} exposes REST endpoints that allow programmatic access and 
+management of {+onprem+}. API requests accept JSON as body parameters, 
+and the API responses are also JSON. 
+
+Section Overview
+----------------
+
+:ref:`{+admin-api+} Principles <public-api-principles>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn about how the {+onprem+}\'s Public REST API exposes programmatic access to 
+Ops Manager's features in this section. 
+
+:ref:`{+onprem+} Administration API Resources <admin-backup-api-resources>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn about each endpoint that the {+onprem+} API exposes, including the 
+path to send your request to, any optional and required parameters, and the 
+values that the {+admin-api+} returns.
+
+:ref:`{+admin-api+} Administration API Error Codes <api-error-codes>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn about the various error codes that the {+admin-api+} might send in this section.  
+
+:ref:`{+admin-api+} Access Configuration <configure-api-access>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn about {+admin-api+} configuration details for generating 
+an {+admin-api+} key in this section.
+
+:ref:`{+admin-api+} Administration API Tutorials <api-tutorials>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+   
+Learn how you can perform varioius {+admin-api+} actions, such as 
+deploying a cluster, rotating a key file and more in this section. 
+
 .. toctree::
    :titlesonly:
    :hidden:
diff --git a/source/core/api.txt b/source/core/api.txt
@@ -1,3 +1,5 @@
+.. _public-api-principles:
+
 =======================
 Public |api| Principles
 =======================
diff --git a/source/tutorial/add-servers-automation.txt b/source/tutorial/add-servers-automation.txt
@@ -1,3 +1,5 @@
+.. _add-servers-automation:
+
 ================================
 Provision Servers for Automation
 ================================
diff --git a/source/tutorial/add-shard-using-automation.txt b/source/tutorial/add-shard-using-automation.txt
@@ -1,3 +1,5 @@
+.. _add-shard-using-automation:
+
 ================================
 Add a Shard to a MongoDB Cluster
 ================================
diff --git a/source/tutorial/change-mongodb-version.txt b/source/tutorial/change-mongodb-version.txt
@@ -1,3 +1,5 @@
+.. _change-mongodb-version:
+
 =============================
 Change the Version of MongoDB
 =============================
diff --git a/source/tutorial/configure-public-api-access.txt b/source/tutorial/configure-public-api-access.txt
@@ -1,3 +1,5 @@
+.. _configure-api-access:
+
 ====================
 Configure API Access
 ====================
diff --git a/source/tutorial/convert-config-servers-to-replica-set.txt b/source/tutorial/convert-config-servers-to-replica-set.txt
@@ -1,3 +1,5 @@
+.. _convert-config-servers-to-replica-set:
+
 =======================================
 Convert Config Servers to a Replica Set
 =======================================
diff --git a/source/tutorial/convert-replica-set-to-sharded-cluster.txt b/source/tutorial/convert-replica-set-to-sharded-cluster.txt
@@ -1,3 +1,5 @@
+.. _convert-replica-set-to-sharded-cluster:
+
 ==========================================
 Convert a Replica Set to a Sharded Cluster
 ==========================================
diff --git a/source/tutorial/convert-standalone-to-replica-set.txt b/source/tutorial/convert-standalone-to-replica-set.txt
@@ -1,3 +1,5 @@
+.. _convert-standalone-to-replica-set:
+
 =====================================
 Convert a Standalone to a Replica Set
 =====================================
diff --git a/source/tutorial/edit-replica-set.txt b/source/tutorial/edit-replica-set.txt
@@ -1,3 +1,5 @@
+.. _edit-replica-set:
+
 ==================
 Edit a Replica Set
 ==================
diff --git a/source/tutorial/manage-bi-connector.txt b/source/tutorial/manage-bi-connector.txt
@@ -1,3 +1,5 @@
+.. _manage-bi-connector:
+
 ============================
 Manage BI Connector in |mms|
 ============================
diff --git a/source/tutorial/migrate-member-to-new-hardware.txt b/source/tutorial/migrate-member-to-new-hardware.txt
@@ -1,3 +1,5 @@
+.. _migrate-replica-set-member:
+
 ============================================
 Migrate a Replica Set Member to a New Server
 ============================================
diff --git a/source/tutorial/nav/add-servers.txt b/source/tutorial/nav/add-servers.txt
@@ -10,10 +10,28 @@ Provision Servers
    :depth: 1
    :class: singlecol
 
+{+onprem+} can automate operations for your MongoDB processes. {+onprem+} can manage existing processes and schedule new processes.
+
+{+onprem+} polls the {+mdbagent+}, 
+which you must install on every MongoDB server to maintain alignment 
+between your desired state and the actual state of your MongoDB server.
+
+Section Overview
+----------------
+
+:ref:`Provision Servers for Automation <add-servers-automation>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to provision MongoDB Automation Agents in this section. 
+
+:ref:`Provision a Migration Host <provision-migration-host>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to provision a MongoDB Migration Host in this section.
 
 .. toctree::
    :titlesonly:
    :hidden:
   
    /tutorial/add-servers-automation
-   /tutorial/provision-migration-host
+   /tutorial/provision-migration-host
diff --git a/source/tutorial/nav/api-tutorials.txt b/source/tutorial/nav/api-tutorials.txt
@@ -1,3 +1,5 @@
+.. _api-tutorials:
+
 ==========================================
 {+admin-api+} Tutorials
 ==========================================
diff --git a/source/tutorial/nav/monitor-and-manage.txt b/source/tutorial/nav/monitor-and-manage.txt
@@ -10,6 +10,110 @@ Manage Deployments
    :depth: 1
    :class: singlecol
 
+You can manage |service| clusters both manually and programatically 
+with a variety of tools, such as the Atlas UI, the Atlas CLI, {+onprem+} 
+and more. 
+
+Managing MongoDB clusters involves tasks such as editing a cluster configuration, 
+upgrading an existing cluster, migrating to a new version of MongoDB and more. 
+
+Section Overview
+----------------
+
+:ref:`View All Clusters <view-all-clusters>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to view all deployments that you have access to in your 
+MongoDB Organization.
+
+:ref:`Prepare for Cluster Maintenance <prepare-for-cluster-maintenance>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to prepare MongoDB clusters for maintenance and the resulting 
+rolling restart for nodes in your cluster in this section. 
+
+:ref:`Edit a Deployment's Configuration <edit-deployment>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to modify a deployment's configuration and topology, including its 
+MongoDB versions, storage engines, and numbers of hosts or shards. 
+
+:ref:`Manage BI Connector in {+onprem+} <manage-bi-connector>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to deploy and manage the |bic-full|.
+
+:ref:`Calculate Suggested Indexes <calculate-suggested-indexes>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to analyze data on query patterns collected by the database 
+profiler and suggest a set of indexes that could improve query performance 
+.
+
+:ref:`Edit a Replica Set <edit-replica-set>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to add, remove, and reconfigure members in a replica set directly in 
+the {+onprem+} console.
+
+:ref:`Convert a Standalone to a Replica Set <convert-standalone-to-replica-set>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to convert a standalone instance to a replica 
+set.
+
+:ref:`Convert a Replica Set to a Sharded Cluster <convert-replica-set-to-sharded-cluster>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to convert a replica set to a sharded cluster.
+
+:ref:`Migrate a Replica Set Member to a New Server <migrate-replica-set-member>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to replace one member of a managed replica set with another member from 
+the {+onprem+} console.
+
+:ref:`Convert Config Servers to a Replica Set <convert-config-servers-to-replica-set>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to ensure that your config servers are available and their metadata 
+is consistent across the config servers.
+
+:ref:`Add a Shard to a MongoDB Cluster <add-shard-using-automation>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to add a shard to a MongoDB sharded cluster.
+
+:ref:`Remove a Shard from a MongoDB Cluster <remove-shard-using-automation>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to remove a shard from a MongoDB sharded cluster.
+
+:ref:`Stop Managing and/or Monitoring One Deployment <unmanage-deployment>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to manage, monitor, and back up your deployments without 
+automation.
+
+:ref:`MongoDB Processes <shut-down-deployment>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to shut down, restart, sync, suspend, and resume a process running 
+in {+onprem+}. 
+
+:ref:`MongoDB Versions <change-mongodb-version>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn how to change your MongoDB version and how to deploy a custom MongoDB 
+build. 
+
+:ref:`Host Mappings <host-map>`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Learn about host mappings and how {+onprem+} mananages and maintains host 
+mappings.
+
+
 .. toctree::
    :titlesonly:
    :hidden:
diff --git a/source/tutorial/prepare-for-maintenance.txt b/source/tutorial/prepare-for-maintenance.txt
@@ -1,3 +1,5 @@
+.. _prepare-for-cluster-maintenance:
+
 ===============================
 Prepare for Cluster Maintenance
 ===============================
diff --git a/source/tutorial/remove-shard-using-automation.txt b/source/tutorial/remove-shard-using-automation.txt
@@ -1,3 +1,5 @@
+.. _remove-shard-using-automation:
+
 =====================================
 Remove a Shard from a MongoDB Cluster
 =====================================
diff --git a/source/tutorial/shut-down-deployment.txt b/source/tutorial/shut-down-deployment.txt
@@ -1,3 +1,5 @@
+.. _shut-down-deployment:
+
 ===========================
 Shut Down MongoDB Processes
 ===========================
diff --git a/source/tutorial/suggest-indexes.txt b/source/tutorial/suggest-indexes.txt
@@ -1,3 +1,5 @@
+.. _calculate-suggested-indexes:
+
 ===========================
 Calculate Suggested Indexes
 ===========================
diff --git a/source/tutorial/unmanage-deployment.txt b/source/tutorial/unmanage-deployment.txt
@@ -1,3 +1,5 @@
+.. _unmanage-deployment:
+
 ==============================================
 Stop Managing and/or Monitoring One Deployment
 ==============================================

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _public-api-principles:`
	`2`	`+`
`1`	`3`	`=======================`
`2`	`4`	`Public \|api\| Principles`
`3`	`5`	`=======================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _add-servers-automation:`
	`2`	`+`
`1`	`3`	`================================`
`2`	`4`	`Provision Servers for Automation`
`3`	`5`	`================================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _add-shard-using-automation:`
	`2`	`+`
`1`	`3`	`================================`
`2`	`4`	`Add a Shard to a MongoDB Cluster`
`3`	`5`	`================================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _change-mongodb-version:`
	`2`	`+`
`1`	`3`	`=============================`
`2`	`4`	`Change the Version of MongoDB`
`3`	`5`	`=============================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _configure-api-access:`
	`2`	`+`
`1`	`3`	`====================`
`2`	`4`	`Configure API Access`
`3`	`5`	`====================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _convert-config-servers-to-replica-set:`
	`2`	`+`
`1`	`3`	`=======================================`
`2`	`4`	`Convert Config Servers to a Replica Set`
`3`	`5`	`=======================================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _convert-replica-set-to-sharded-cluster:`
	`2`	`+`
`1`	`3`	`==========================================`
`2`	`4`	`Convert a Replica Set to a Sharded Cluster`
`3`	`5`	`==========================================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _convert-standalone-to-replica-set:`
	`2`	`+`
`1`	`3`	`=====================================`
`2`	`4`	`Convert a Standalone to a Replica Set`
`3`	`5`	`=====================================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _edit-replica-set:`
	`2`	`+`
`1`	`3`	`==================`
`2`	`4`	`Edit a Replica Set`
`3`	`5`	`==================`