diff --git a/README.md b/README.md index efb853dc1..dd793e10f 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,21 @@ # docs-cluster-to-cluster-sync -[Your words here]. +Documentation for the cluster to cluster synchronization tool, +mongosync. Report Issues ------------- To file issues or requests regarding the documentation, go to the -`Documentation Jira Project `_. +[Documentation Jira Project](https://jira.mongodb.org/browse/DOCS). License ------- -All documentation is available under the terms of a `Creative Commons -License `_. +All documentation is available under the terms of a [Creative Commons +License](https://creativecommons.org/licenses/by-nc-sa/3.0/). -If you have any questions, please contact `docs@mongodb.com -`_. +If you have any questions, please contact [docs@mongodb.com] +(mailto:docs@mongodb.com>). -- The MongoDB Documentation Team diff --git a/snooty.toml b/snooty.toml index f4960c7b4..532ca6e66 100644 --- a/snooty.toml +++ b/snooty.toml @@ -3,9 +3,15 @@ title = "MongoDB Cluster-to-Cluster Synchronization" intersphinx = [ "https://docs.mongodb.com/manual/objects.inv" ] -# toc_landing_pages = ["/paths/to/pages/that/have/nested/content"] +toc_landing_pages = ["/overview", + "/quickstart", + "reference/reference", + "/release-notes/release-notes", + "/faq" + ] [constants] -# constant = "value" version = "1.0.0" +[substitutions] +# string = "some other string" diff --git a/source/connecting.txt b/source/connecting.txt new file mode 100644 index 000000000..58d873914 --- /dev/null +++ b/source/connecting.txt @@ -0,0 +1,13 @@ +.. place holder for the installation section TOC + +========== +Connecting +========== + +.. toctree:: + :titlesonly: + + /connecting/atlas-to-atlas + /connecting/onprem-onprem + /connecting/onprem-to-atlas + diff --git a/source/connecting/atlas-to-atlas.txt b/source/connecting/atlas-to-atlas.txt new file mode 100644 index 000000000..54f058938 --- /dev/null +++ b/source/connecting/atlas-to-atlas.txt @@ -0,0 +1,10 @@ +.. _c2c-conn-atlas2atlas: + +========================== +Connect Two Atlas Clusters +========================== + +.. default-domain:: mongodb + +Connect two Atlas clusters + diff --git a/source/connecting/onprem-onprem.txt b/source/connecting/onprem-onprem.txt new file mode 100644 index 000000000..c6d13c091 --- /dev/null +++ b/source/connecting/onprem-onprem.txt @@ -0,0 +1,10 @@ +.. _c2c-conn-oprem2onprem: + +========================== +Connect Two Local Clusters +========================== + +.. default-domain:: mongodb + +Onprem to onprem + diff --git a/source/connecting/onprem-to-atlas.txt b/source/connecting/onprem-to-atlas.txt new file mode 100644 index 000000000..83e5122ba --- /dev/null +++ b/source/connecting/onprem-to-atlas.txt @@ -0,0 +1,10 @@ +.. _c2c-conn-onprem2atlas: + +================================ +Connect a Local Cluster to Atlas +================================ + +.. default-domain:: mongodb + +onprem to atlas + diff --git a/source/faq.txt b/source/faq.txt new file mode 100644 index 000000000..2354c67e2 --- /dev/null +++ b/source/faq.txt @@ -0,0 +1,12 @@ +.. _c2c-faq: + +========================== +Frequently Asked Questions +========================== + +.. default-domain:: mongodb + + +This page provides answers to some frequently asked questions we have +encountered. If you have additional questions please contact MongoDB +Support. diff --git a/source/index.txt b/source/index.txt index f4c41b8f4..1a7ecf524 100644 --- a/source/index.txt +++ b/source/index.txt @@ -1,9 +1,23 @@ +.. _c2c-index: + ========================================== MongoDB Cluster-to-Cluster Synchronization ========================================== .. default-domain:: mongodb -Your words here. Don't forget to add a toctree! +The primary motivation of this initiative ... + +NOTE: This page will have material that introduces C2C to the reader. + +.. toctree:: + :titlesonly: + /quickstart + /installation + /running-mongosync + /connecting + /reference + /release-notes + /faq diff --git a/source/installation.txt b/source/installation.txt new file mode 100644 index 000000000..b401c99df --- /dev/null +++ b/source/installation.txt @@ -0,0 +1,13 @@ +.. place holder for the installation section TOC + +============ +Installation +============ + +.. toctree:: + :titlesonly: + + /installation/install-on-linux + /installation/install-on-macos + /installation/install-on-windows + diff --git a/source/installation/install-on-linux.txt b/source/installation/install-on-linux.txt new file mode 100644 index 000000000..5217d5355 --- /dev/null +++ b/source/installation/install-on-linux.txt @@ -0,0 +1,10 @@ +.. _c2c-install-linux: + +================ +Install on Linux +================ + +.. default-domain:: mongodb + +Linux install pages + diff --git a/source/installation/install-on-macos.txt b/source/installation/install-on-macos.txt new file mode 100644 index 000000000..1d03db002 --- /dev/null +++ b/source/installation/install-on-macos.txt @@ -0,0 +1,10 @@ +.. _c2c-install-macos: + +================ +Install on macOS +================ + +.. default-domain:: mongodb + +OSX install + diff --git a/source/installation/install-on-windows.txt b/source/installation/install-on-windows.txt new file mode 100644 index 000000000..835ea4405 --- /dev/null +++ b/source/installation/install-on-windows.txt @@ -0,0 +1,10 @@ +.. _c2c-install-windows: + +================== +Install on Windows +================== + +.. default-domain:: mongodb + +Windows install + diff --git a/source/overview.txt b/source/overview.txt new file mode 100644 index 000000000..f7a0dfa69 --- /dev/null +++ b/source/overview.txt @@ -0,0 +1,10 @@ +.. _c2c-overview: + +======== +Overview +======== + +.. default-domain:: mongodb + +The primary motivation of this initiative ... + diff --git a/source/quickstart.txt b/source/quickstart.txt new file mode 100644 index 000000000..8ac9db19a --- /dev/null +++ b/source/quickstart.txt @@ -0,0 +1,10 @@ +.. _c2c-quickstart: + +=========== +Quick Start +=========== + +.. default-domain:: mongodb + +Get going! + diff --git a/source/reference.txt b/source/reference.txt new file mode 100644 index 000000000..2a131f175 --- /dev/null +++ b/source/reference.txt @@ -0,0 +1,11 @@ +.. place holder for the reference section TOC + +========= +Reference +========= + +.. toctree:: + :titlesonly: + + /reference/mongosync + diff --git a/source/reference/mongosync.txt b/source/reference/mongosync.txt new file mode 100644 index 000000000..4aa44c94f --- /dev/null +++ b/source/reference/mongosync.txt @@ -0,0 +1,9 @@ +.. _c2c-mongosync: + +============= +``mongosync`` +============= + +.. default-domain:: mongodb + +Migrate data between clusters using ``mongosync``. diff --git a/source/release-notes.txt b/source/release-notes.txt new file mode 100644 index 000000000..324c9d88c --- /dev/null +++ b/source/release-notes.txt @@ -0,0 +1,11 @@ +.. place holder for the release notes TOC + +============= +Release Notes +============= + +.. toctree:: + :titlesonly: + + /release-notes/0.9 + diff --git a/source/release-notes/0.9.txt b/source/release-notes/0.9.txt new file mode 100644 index 000000000..6c5b92623 --- /dev/null +++ b/source/release-notes/0.9.txt @@ -0,0 +1,19 @@ +.. _c2c-release-notes-0.9: + +=================================== +Release Notes for ``mongosync`` 0.9 +=================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +New Features +------------ + +Cool new stuff goes here. + diff --git a/source/running-mongosync.txt b/source/running-mongosync.txt new file mode 100644 index 000000000..3aa3cbcf5 --- /dev/null +++ b/source/running-mongosync.txt @@ -0,0 +1,12 @@ +.. place holder for the running mongosync section TOC + +===================== +Running ``mongosync`` +===================== + +.. toctree:: + :titlesonly: + + /running-mongosync/continuous-sync + /running-mongosync/migration + diff --git a/source/running-mongosync/continuous-sync.txt b/source/running-mongosync/continuous-sync.txt new file mode 100644 index 000000000..fd2182b43 --- /dev/null +++ b/source/running-mongosync/continuous-sync.txt @@ -0,0 +1,10 @@ +.. _c2c-run-continue-sync: + +========================== +Continuous Synchronization +========================== + +.. default-domain:: mongodb + +Continuous synch use case + diff --git a/source/running-mongosync/migration.txt b/source/running-mongosync/migration.txt new file mode 100644 index 000000000..4db76ea7d --- /dev/null +++ b/source/running-mongosync/migration.txt @@ -0,0 +1,10 @@ +.. _c2c-run-migration: + +========= +Migration +========= + +.. default-domain:: mongodb + +migration use case +