Merge pull request #420 from NASA-AMMOS/docs/aerie-2186--update-docs-toc

[Aerie 2186] Update Website Layout
NASA-AMMOS · Nov 4, 2022 · 41c6657 · 41c6657
2 parents 355f98d + ac12ef5
commit 41c6657
Show file tree

Hide file tree

Showing 201 changed files with 3,618 additions and 90 deletions.
diff --git a/docs/buildExternalDocs.bash b/docs/buildExternalDocs.bash
@@ -3,9 +3,6 @@
 # Build the EDSL documentation and insert it into the current build directory
 ../gradlew publishDocs -p ../
 
-ls -1 ../merlin-server/constraints-dsl-compiler/build/
-pwd
-ls -1 ./source
 
 mkdir -p ./source/constraints-edsl-api
 cp -a ../merlin-server/constraints-dsl-compiler/build/docs/. ./source/constraints-edsl-api
@@ -20,6 +17,8 @@ rm -rf ./source/scheduling-edsl-api/*/Constraint_eDSL.*
 # Remove the extra navigation bar from the generated Constraints EDSL files
 tail -n +3 "./source/constraints-edsl-api/README.md" > "./source/constraints-edsl-api/README.tmp" && mv "./source/constraints-edsl-api/README.tmp" "./source/constraints-edsl-api/README.md"
 sed -i -e 's/README/index/g' ./source/constraints-edsl-api/README.md
+# Remove the word 'Documentation' in the title
+sed -i -e 's/Documentation//' ./source/constraints-edsl-api/README.md
 
 for file in ./source/constraints-edsl-api/classes/*.md
 do

diff --git a/docs/source/activity-plans/index.rst → docs/old_site/activity-plans/index.rst b/docs/source/activity-plans/index.rst → docs/old_site/activity-plans/index.rst
diff --git a/...mission-model-configuration-parameters.md → ...mission-model-configuration-parameters.md b/...mission-model-configuration-parameters.md → ...mission-model-configuration-parameters.md
diff --git a/...ce/activity-plans/precomputed-profiles.md → ...te/activity-plans/precomputed-profiles.md b/...ce/activity-plans/precomputed-profiles.md → ...te/activity-plans/precomputed-profiles.md
diff --git a/...ource/activity-plans/scheduling-guide.rst → ..._site/activity-plans/scheduling-guide.rst b/...ource/activity-plans/scheduling-guide.rst → ..._site/activity-plans/scheduling-guide.rst
diff --git a/...ctivity-plans/simulation-configuration.md → ...ctivity-plans/simulation-configuration.md b/...ctivity-plans/simulation-configuration.md → ...ctivity-plans/simulation-configuration.md
diff --git a/...urce/activity-plans/simulation-results.md → ...site/activity-plans/simulation-results.md b/...urce/activity-plans/simulation-results.md → ...site/activity-plans/simulation-results.md
diff --git a/...mand-expansion/create-an-expansion-set.md → ...mand-expansion/create-an-expansion-set.md b/...mand-expansion/create-an-expansion-set.md → ...mand-expansion/create-an-expansion-set.md
diff --git a/...urce/command-expansion/create-sequence.md → ...site/command-expansion/create-sequence.md b/...urce/command-expansion/create-sequence.md → ...site/command-expansion/create-sequence.md
diff --git a/...urce/command-expansion/expand-the-plan.md → ...site/command-expansion/expand-the-plan.md b/...urce/command-expansion/expand-the-plan.md → ...site/command-expansion/expand-the-plan.md
diff --git a/...xpansion/expansion-authoring-ide-setup.md → ...xpansion/expansion-authoring-ide-setup.md b/...xpansion/expansion-authoring-ide-setup.md → ...xpansion/expansion-authoring-ide-setup.md
diff --git a/.../command-expansion/expansion-logic-api.md → .../command-expansion/expansion-logic-api.md b/.../command-expansion/expansion-logic-api.md → .../command-expansion/expansion-logic-api.md
diff --git a/...n/generate-activity-typescript-library.md → ...n/generate-activity-typescript-library.md b/...n/generate-activity-typescript-library.md → ...n/generate-activity-typescript-library.md
diff --git a/...ate-seqjson-from-a-standalone-sequence.md → ...ate-seqjson-from-a-standalone-sequence.md b/...ate-seqjson-from-a-standalone-sequence.md → ...ate-seqjson-from-a-standalone-sequence.md
diff --git a/...ommand-expansion/get-expanded-commands.md → ...ommand-expansion/get-expanded-commands.md b/...ommand-expansion/get-expanded-commands.md → ...ommand-expansion/get-expanded-commands.md
diff --git a/docs/source/command-expansion/index.rst → docs/old_site/command-expansion/index.rst b/docs/source/command-expansion/index.rst → docs/old_site/command-expansion/index.rst
diff --git a/...on/link-simulated-activity-to-sequence.md → ...on/link-simulated-activity-to-sequence.md b/...on/link-simulated-activity-to-sequence.md → ...on/link-simulated-activity-to-sequence.md
diff --git a/...ieve-seqjson-serialization-of-sequence.md → ...ieve-seqjson-serialization-of-sequence.md b/...ieve-seqjson-serialization-of-sequence.md → ...ieve-seqjson-serialization-of-sequence.md
diff --git a/...mmand-expansion/submit-expansion-logic.md → ...mmand-expansion/submit-expansion-logic.md b/...mmand-expansion/submit-expansion-logic.md → ...mmand-expansion/submit-expansion-logic.md
diff --git a/...load-and-generate-command-library-file.md → ...load-and-generate-command-library-file.md b/...load-and-generate-command-library-file.md → ...load-and-generate-command-library-file.md
diff --git a/...d-expansion/valid-sequence-json-format.md → ...d-expansion/valid-sequence-json-format.md b/...d-expansion/valid-sequence-json-format.md → ...d-expansion/valid-sequence-json-format.md
diff --git a/docs/source/constraints/index.rst → docs/old_site/constraints/index.rst b/docs/source/constraints/index.rst → docs/old_site/constraints/index.rst
diff --git a/docs/source/constraints/overview.md → docs/old_site/constraints/overview.md b/docs/source/constraints/overview.md → docs/old_site/constraints/overview.md
diff --git a/docs/source/contribute/contribute-docs.rst → docs/old_site/contribute/contribute-docs.rst b/docs/source/contribute/contribute-docs.rst → docs/old_site/contribute/contribute-docs.rst
diff --git a/docs/old_site/contribute/index.rst b/docs/old_site/contribute/index.rst
@@ -0,0 +1,17 @@
+==========
+Contribute
+==========
+
+.. toctree::
+   :hidden:
+
+   Contribute to the Source Code <https://github.com/NASA-AMMOS/aerie/blob/develop/CONTRIBUTING.md>
+   Contribute to the documentation <contribute-docs>
+   Source Code <https://github.com/NASA-AMMOS/aerie>
+
+We are always looking for those who want to help and appreciate any contribution we can get.
+
+There are two ways to contribute to Aerie :
+
+* `Contribute to the Source Code <https://github.com/NASA-AMMOS/aerie/blob/develop/CONTRIBUTING.md>`_ - over on our GitHub.
+* :doc:`Contribute to the documentation <contribute-docs>` - by writing new or changing existing Documentation.
diff --git a/docs/source/deployment/aws-deployment.md → docs/old_site/deployment/aws-deployment.md b/docs/source/deployment/aws-deployment.md → docs/old_site/deployment/aws-deployment.md
diff --git a/docs/source/deployment/building-windows.rst → .../old_site/deployment/building-windows.rst b/docs/source/deployment/building-windows.rst → .../old_site/deployment/building-windows.rst
diff --git a/docs/source/deployment/building.md → docs/old_site/deployment/building.md b/docs/source/deployment/building.md → docs/old_site/deployment/building.md
diff --git a/docs/source/deployment/index.rst → docs/old_site/deployment/index.rst b/docs/source/deployment/index.rst → docs/old_site/deployment/index.rst
diff --git a/docs/source/deployment/product-support.md → docs/old_site/deployment/product-support.md b/docs/source/deployment/product-support.md → docs/old_site/deployment/product-support.md
diff --git a/...urce/deployment/single-host-deployment.md → ...site/deployment/single-host-deployment.md b/...urce/deployment/single-host-deployment.md → ...site/deployment/single-host-deployment.md
diff --git a/.../source/deployment/system-requirements.md → ...ld_site/deployment/system-requirements.md b/.../source/deployment/system-requirements.md → ...ld_site/deployment/system-requirements.md
diff --git a/.../source/deployment/ui-custom-base-path.md → ...ld_site/deployment/ui-custom-base-path.md b/.../source/deployment/ui-custom-base-path.md → ...ld_site/deployment/ui-custom-base-path.md
diff --git a/docs/source/examples/admonitions.rst → docs/old_site/examples/admonitions.rst b/docs/source/examples/admonitions.rst → docs/old_site/examples/admonitions.rst
diff --git a/docs/source/examples/code-blocks.rst → docs/old_site/examples/code-blocks.rst b/docs/source/examples/code-blocks.rst → docs/old_site/examples/code-blocks.rst
diff --git a/docs/source/examples/collapse.rst → docs/old_site/examples/collapse.rst b/docs/source/examples/collapse.rst → docs/old_site/examples/collapse.rst
diff --git a/docs/source/examples/glossary.rst → docs/old_site/examples/glossary.rst b/docs/source/examples/glossary.rst → docs/old_site/examples/glossary.rst
diff --git a/docs/source/examples/headings.rst → docs/old_site/examples/headings.rst b/docs/source/examples/headings.rst → docs/old_site/examples/headings.rst
diff --git a/docs/source/examples/hero-box.rst → docs/old_site/examples/hero-box.rst b/docs/source/examples/hero-box.rst → docs/old_site/examples/hero-box.rst
diff --git a/docs/source/examples/images.rst → docs/old_site/examples/images.rst b/docs/source/examples/images.rst → docs/old_site/examples/images.rst
diff --git a/docs/source/examples/images/checkmark.png → docs/old_site/examples/images/checkmark.png b/docs/source/examples/images/checkmark.png → docs/old_site/examples/images/checkmark.png
diff --git a/docs/source/examples/images/diagram.svg → docs/old_site/examples/images/diagram.svg b/docs/source/examples/images/diagram.svg → docs/old_site/examples/images/diagram.svg
diff --git a/docs/source/examples/includes.rst → docs/old_site/examples/includes.rst b/docs/source/examples/includes.rst → docs/old_site/examples/includes.rst
diff --git a/docs/source/examples/index.rst → docs/old_site/examples/index.rst b/docs/source/examples/index.rst → docs/old_site/examples/index.rst
diff --git a/docs/source/examples/links.rst → docs/old_site/examples/links.rst b/docs/source/examples/links.rst → docs/old_site/examples/links.rst
diff --git a/docs/source/examples/lists.rst → docs/old_site/examples/lists.rst b/docs/source/examples/lists.rst → docs/old_site/examples/lists.rst
diff --git a/docs/source/examples/panel-box.rst → docs/old_site/examples/panel-box.rst b/docs/source/examples/panel-box.rst → docs/old_site/examples/panel-box.rst
diff --git a/docs/source/examples/substitutions.rst → docs/old_site/examples/substitutions.rst b/docs/source/examples/substitutions.rst → docs/old_site/examples/substitutions.rst
diff --git a/docs/source/examples/tables.rst → docs/old_site/examples/tables.rst b/docs/source/examples/tables.rst → docs/old_site/examples/tables.rst
diff --git a/docs/source/examples/tabs.rst → docs/old_site/examples/tabs.rst b/docs/source/examples/tabs.rst → docs/old_site/examples/tabs.rst
diff --git a/docs/source/examples/text.rst → docs/old_site/examples/text.rst b/docs/source/examples/text.rst → docs/old_site/examples/text.rst
diff --git a/docs/source/examples/toc.rst → docs/old_site/examples/toc.rst b/docs/source/examples/toc.rst → docs/old_site/examples/toc.rst
diff --git a/docs/source/examples/topic-box.rst → docs/old_site/examples/topic-box.rst b/docs/source/examples/topic-box.rst → docs/old_site/examples/topic-box.rst
diff --git a/docs/source/examples/versions.rst → docs/old_site/examples/versions.rst b/docs/source/examples/versions.rst → docs/old_site/examples/versions.rst
diff --git a/docs/source/graphql-api/examples.md → docs/old_site/graphql-api/examples.md b/docs/source/graphql-api/examples.md → docs/old_site/graphql-api/examples.md
diff --git a/docs/source/graphql-api/index.rst → docs/old_site/graphql-api/index.rst b/docs/source/graphql-api/index.rst → docs/old_site/graphql-api/index.rst
diff --git a/docs/source/graphql-api/overview.md → docs/old_site/graphql-api/overview.md b/docs/source/graphql-api/overview.md → docs/old_site/graphql-api/overview.md
diff --git a/...ages/deployment-windows/docker-distro.png → ...ages/deployment-windows/docker-distro.png b/...ages/deployment-windows/docker-distro.png → ...ages/deployment-windows/docker-distro.png
diff --git a/...images/deployment-windows/docker-wsl2.png → ...images/deployment-windows/docker-wsl2.png b/...images/deployment-windows/docker-wsl2.png → ...images/deployment-windows/docker-wsl2.png
diff --git a/...images/deployment-windows/hyper-v-off.png → ...images/deployment-windows/hyper-v-off.png b/...images/deployment-windows/hyper-v-off.png → ...images/deployment-windows/hyper-v-off.png
diff --git a/.../images/deployment-windows/hyper-v-on.png → .../images/deployment-windows/hyper-v-on.png b/.../images/deployment-windows/hyper-v-on.png → .../images/deployment-windows/hyper-v-on.png
diff --git a/...mages/deployment-windows/task-manager.png → ...mages/deployment-windows/task-manager.png b/...mages/deployment-windows/task-manager.png → ...mages/deployment-windows/task-manager.png
diff --git a/...s/deployment-windows/windows-features.png → ...s/deployment-windows/windows-features.png b/...s/deployment-windows/windows-features.png → ...s/deployment-windows/windows-features.png
diff --git a/docs/source/images/fig-1.png → docs/old_site/images/fig-1.png b/docs/source/images/fig-1.png → docs/old_site/images/fig-1.png
diff --git a/docs/source/images/sim-engine/image1.png → docs/old_site/images/sim-engine/image1.png b/docs/source/images/sim-engine/image1.png → docs/old_site/images/sim-engine/image1.png
diff --git a/docs/source/images/sim-engine/image10.png → docs/old_site/images/sim-engine/image10.png b/docs/source/images/sim-engine/image10.png → docs/old_site/images/sim-engine/image10.png
diff --git a/docs/source/images/sim-engine/image11.png → docs/old_site/images/sim-engine/image11.png b/docs/source/images/sim-engine/image11.png → docs/old_site/images/sim-engine/image11.png
diff --git a/docs/source/images/sim-engine/image12.png → docs/old_site/images/sim-engine/image12.png b/docs/source/images/sim-engine/image12.png → docs/old_site/images/sim-engine/image12.png
diff --git a/docs/source/images/sim-engine/image13.png → docs/old_site/images/sim-engine/image13.png b/docs/source/images/sim-engine/image13.png → docs/old_site/images/sim-engine/image13.png
diff --git a/docs/source/images/sim-engine/image14.png → docs/old_site/images/sim-engine/image14.png b/docs/source/images/sim-engine/image14.png → docs/old_site/images/sim-engine/image14.png
diff --git a/docs/source/images/sim-engine/image15.png → docs/old_site/images/sim-engine/image15.png b/docs/source/images/sim-engine/image15.png → docs/old_site/images/sim-engine/image15.png
diff --git a/docs/source/images/sim-engine/image2.png → docs/old_site/images/sim-engine/image2.png b/docs/source/images/sim-engine/image2.png → docs/old_site/images/sim-engine/image2.png
diff --git a/docs/source/images/sim-engine/image3.png → docs/old_site/images/sim-engine/image3.png b/docs/source/images/sim-engine/image3.png → docs/old_site/images/sim-engine/image3.png
diff --git a/docs/source/images/sim-engine/image4.png → docs/old_site/images/sim-engine/image4.png b/docs/source/images/sim-engine/image4.png → docs/old_site/images/sim-engine/image4.png
diff --git a/docs/source/images/sim-engine/image5.png → docs/old_site/images/sim-engine/image5.png b/docs/source/images/sim-engine/image5.png → docs/old_site/images/sim-engine/image5.png
diff --git a/docs/source/images/sim-engine/image6.png → docs/old_site/images/sim-engine/image6.png b/docs/source/images/sim-engine/image6.png → docs/old_site/images/sim-engine/image6.png
diff --git a/docs/source/images/sim-engine/image7.png → docs/old_site/images/sim-engine/image7.png b/docs/source/images/sim-engine/image7.png → docs/old_site/images/sim-engine/image7.png
diff --git a/docs/source/images/sim-engine/image8.png → docs/old_site/images/sim-engine/image8.png b/docs/source/images/sim-engine/image8.png → docs/old_site/images/sim-engine/image8.png
diff --git a/docs/source/images/sim-engine/image9.png → docs/old_site/images/sim-engine/image9.png b/docs/source/images/sim-engine/image9.png → docs/old_site/images/sim-engine/image9.png
diff --git a/docs/old_site/index.rst b/docs/old_site/index.rst
@@ -0,0 +1,122 @@
+:orphan:
+:full-width:
+.. .:. landing:
+
+:hide-sidebar:
+:hide-secondary-sidebar:
+:hide-version-warning:
+:hide-pre-content:
+:hide-post-content:
+
+
+.. title:: Aerie Documentation
+
+.. hero-box::
+  :title: Welcome to the Aerie Documentation
+
+.. raw:: html
+
+  <div class="landing__content">
+
+.. raw:: html
+
+  <div class="topics-grid grid-container full">
+
+  <div class="grid-x grid-margin-x">
+
+.. topic-box::
+  :title: Mission Modeling
+  :link: mission-modeling
+  :icon: scylla-icon scylla-icon--networking
+  :class: large-6
+  :anchor: Learn more
+
+  Develop a mission model to support simulation and mission planning.
+
+.. topic-box::
+  :title: Creating & Simulating Activity Plans
+  :link: activity-plans
+  :icon: scylla-icon scylla-icon--benchmarks
+  :class: large-6
+  :anchor: Learn more
+
+  Create activity plans, configure simulations, and populate a plan with automated scheduling.
+
+.. topic-box::
+  :title: Command Expansion
+  :link: command-expansion
+  :icon: scylla-icon scylla-icon--apps
+  :class: large-6
+  :anchor: Learn more
+
+  Author command expansion logic and link activities to their command expansions.
+
+.. topic-box::
+  :title: User Interface
+  :link: user-interface
+  :icon: scylla-icon scylla-icon--architecture
+  :class: large-6
+  :anchor: Learn more
+
+  The client application and API guide.
+
+.. topic-box::
+	:title: Constraints EDSL APIs
+	:link: constraints-edsl-api
+	:icon: scylla-icon scylla-icon--about-team
+	:class: large-6
+	:anchor: Learn more
+
+	Constraints EDSL APIs for defining constraints on activity plans.
+
+.. topic-box::
+	:title: Scheduling EDSL APIs
+	:link: scheduling-edsl-api
+	:icon: scylla-icon scylla-icon--about-team
+	:class: large-6
+	:anchor: Learn more
+
+	Scheduling EDSL APIs for defining scheduling rules.
+
+.. topic-box::
+  :title: Deployment
+  :link: deployment
+  :icon: scylla-icon scylla-icon--cloud
+  :class: large-6
+  :anchor: Learn more
+
+  Deploy Aerie for individual users, small and large missions.
+
+.. topic-box::
+  :title: Contribute
+  :link: contribute
+  :icon: scylla-icon scylla-icon--about-team
+  :class: large-6
+  :anchor: Learn more
+
+  Get setup for development as a contributor to the Aerie project.
+
+.. raw:: html
+
+  </div></div>
+
+.. raw:: html
+
+  </div>
+
+.. toctree::
+  :hidden:
+  :includehidden:
+
+  activity-plans/index
+  aerie-glossary
+  command-expansion/index
+  constraints/index
+  contribute/index
+  deployment/index
+  graphql-api/index
+  mission-modeling/index
+  upgrade-guides/index
+  user-interface/index
+  constraints-edsl-api/index
+  scheduling-edsl-api/index
diff --git a/...ion-modeling/_draft_simulation-engine.rst → ...ion-modeling/_draft_simulation-engine.rst b/...ion-modeling/_draft_simulation-engine.rst → ...ion-modeling/_draft_simulation-engine.rst
diff --git a/docs/source/mission-modeling/activities.md → docs/old_site/mission-modeling/activities.md b/docs/source/mission-modeling/activities.md → docs/old_site/mission-modeling/activities.md
diff --git a/...urce/mission-modeling/activity-mappers.md → ...site/mission-modeling/activity-mappers.md b/...urce/mission-modeling/activity-mappers.md → ...site/mission-modeling/activity-mappers.md
diff --git a/.../mission-modeling/activity-parameters.rst → .../mission-modeling/activity-parameters.rst b/.../mission-modeling/activity-parameters.rst → .../mission-modeling/activity-parameters.rst
diff --git a/...n-modeling/configuring-a-mission-model.md → ...n-modeling/configuring-a-mission-model.md b/...n-modeling/configuring-a-mission-model.md → ...n-modeling/configuring-a-mission-model.md
diff --git a/...on-modeling/developing-a-mission-model.md → ...on-modeling/developing-a-mission-model.md b/...on-modeling/developing-a-mission-model.md → ...on-modeling/developing-a-mission-model.md
diff --git a/...oundations-of-simulation-and-modeling.rst → ...oundations-of-simulation-and-modeling.rst b/...oundations-of-simulation-and-modeling.rst → ...oundations-of-simulation-and-modeling.rst
diff --git a/docs/source/mission-modeling/index.rst → docs/old_site/mission-modeling/index.rst b/docs/source/mission-modeling/index.rst → docs/old_site/mission-modeling/index.rst
diff --git a/...mission-model-configuration-parameters.md → ...mission-model-configuration-parameters.md b/...mission-model-configuration-parameters.md → ...mission-model-configuration-parameters.md
diff --git a/.../mission-modeling/models-and-resources.md → .../mission-modeling/models-and-resources.md b/.../mission-modeling/models-and-resources.md → .../mission-modeling/models-and-resources.md
diff --git a/.../source/mission-modeling/value-schemas.md → ...ld_site/mission-modeling/value-schemas.md b/.../source/mission-modeling/value-schemas.md → ...ld_site/mission-modeling/value-schemas.md
diff --git a/...-interface/activity-directive-metadata.md → ...-interface/activity-directive-metadata.md b/...-interface/activity-directive-metadata.md → ...-interface/activity-directive-metadata.md
diff --git a/docs/source/user-interface/index.rst → docs/old_site/user-interface/index.rst b/docs/source/user-interface/index.rst → docs/old_site/user-interface/index.rst
diff --git a/docs/source/user-interface/planning.md → docs/old_site/user-interface/planning.md b/docs/source/user-interface/planning.md → docs/old_site/user-interface/planning.md
diff --git a/docs/source/user-interface/views.md → docs/old_site/user-interface/views.md b/docs/source/user-interface/views.md → docs/old_site/user-interface/views.md
diff --git a/docs/poetry.lock b/docs/poetry.lock
diff --git a/docs/source/aerie-glossary.md b/docs/source/aerie-glossary.md
@@ -36,7 +36,7 @@
 
 **Cell**: allows a mission model to express **time-dependent state** in a way that can be tracked and managed by the host system.
 
-**Constraint**: an expression built up with the [Aerie constraints eDSL](./constraints/overview.md), which evaluates to a set of windows during which the condition(s) defined by the expression is true or false.
+**Constraint**: an expression built up with the [Aerie constraints eDSL](./user-guide/ui-api-guide/constraints/index.rst), which evaluates to a set of windows during which the condition(s) defined by the expression is true or false.
 
 **Decomposition**:
 A method for modeling the behavior of an activity (root activity) by composing a set of activities. Each composed activity describes some smaller aspect of behavior. The root activity orchestrates the execution of each child activity by interleaving function calls to `spawn()`, `delay()`, and `call()`. The goal of decomposition is to allow mission modelers to modularize their activity modeling code and to provide greater visibility into the simulated behavior of an activity. For example, consider an activity which models taking an observation with a particular spacecraft instrument. The process of taking an observation may include the distinct phases of instrument startup, take observation, and instrument shutdown. The mission modeler can decide to modularize their modeling and use decomposition to model each of the three phases separately and then compose them with a root activity called "observation" which orchestrates the execution of each of the three activities.

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -55,7 +55,7 @@
 
 # List of substitutions
 rst_prolog = """
-.. |rst| replace:: restructuredText
+.. |rst| replace:: reStructuredText
 """
 # -- Options for not found extension ---------------------------------------
 

diff --git a/docs/source/contact.rst b/docs/source/contact.rst
@@ -0,0 +1,5 @@
+:orphan:
+
+==========
+Contact Us
+==========
diff --git a/docs/source/contribute/documentation/docs-pr.rst b/docs/source/contribute/documentation/docs-pr.rst
@@ -0,0 +1,66 @@
+========================
+Issues and Pull Requests
+========================
+
+Any documentation contribution, no matter how small, is made as a pull request (PR) on `our GitHub <https://github.com/NASA-AMMOS/aerie>`_.
+You can use a client, the Web UI, or the command line to manage your PRs.
+
+Issue assignment
+================
+
+The Aerie repository has `an issues page on GitHub <https://github.com/NASA-AMMOS/aerie/issues>`_.
+Doc issues are labeled with a ``documentation`` label.
+Please do not work on issues that are not assigned to you.
+This avoids working on something someone else is working on.
+Also, if there is an issue with any guide and the issue does not exist, please create an issue so it can be tracked.
+
+Guidelines for branch names
+===========================
+
+If you are providing documentation alongside new code, prefix the name of your branch with ``feature/AERIE-[Issue Number]--``.
+
+If you are only providing documentation, prefix the name of your branch with ``docs/AERIE-[Issue Number]--``.
+
+
+Previewing local changes
+========================
+
+Before submitting docs changes, we ask that you build them first locally. To do so, you will need:
+
+* `Python 3.7 <https://www.python.org/downloads/>`_ or later.
+* `Poetry 1.12 <https://python-poetry.org/docs/master/>`_ or later.
+
+To preview your changes while you are working, run ``make preview`` from the command line in the ``docs`` directory.
+If you have previously run ``make preview``, it is recommended to run ``make clean`` first. Navigate to http://127.0.0.1:5500/.
+The site will automatically update as you work. Fix all warnings raised during the build.
+
+When you are finished making changes, run ``make clean`` and then ``make dirhtml-ext`` to ensure that the site will deploy.
+Once the site builds successfully without warnings, you may proceed to the next step.
+
+To check for broken links, run ``make clean && make dirhtml-ext`` then ``make linkcheck``.
+Once ``make linkcheck`` builds with the only broken links being those that reference ``localhost`` sites, you may proceed to open a PR.
+
+
+Submit a pull request (PR)
+==========================
+
+We expect that you are aware of how to submit a PR to GitHub. If you are not, please look at this `tutorial <https://docs.github.com/en/get-started/quickstart/hello-world>`_.
+When creating a PR, fill out the provided template.
+
+For Documentation PRs, the following guidelines apply:
+
+* Test the instructions against the product. For all tests you must use a clean, new install unless otherwise specified in the issue.
+* Make sure the PR renders with no errors and that make preview does not return any errors.
+* Cite the issue you are fixing in the PR comments and use screenshots to show changes in formatting.
+* In the subject line of the PR prepend the subject with ``[Aerie Issue Number]``.
+* Apply the ``documentation`` label to your PR.
+
+If you have any questions about the process, ask the maintainer of the project you're working on.
+
+Best practices for content submission
+=====================================
+
+* Always open an issue describing what you want to work on if one doesn't already exist.
+* Use GitHub search to see if there is someone else working on the issue already. Look at the open PRs.
+* Test the new / changed content using the make preview script. Confirm there are no compilation errors before submitting.
+* Give some text to your commit message. Explain why you did what you did. If you changed something in formatting, provide a before and after screenshot.
diff --git a/docs/source/contribute/documentation/examples/admonitions.rst b/docs/source/contribute/documentation/examples/admonitions.rst
@@ -0,0 +1,61 @@
+Admonitions
+===========
+
+At Scylla, we limit the admonitions. Although |rst| will allow for more, use the following:
+
+* Note_
+* Caution_
+* Warning_
+* Tip_
+
+Note
+----
+
+Use a note to point out something to the reader. This action does not have any risk.
+
+.. code-block:: rst
+
+   .. note:: text follows here
+
+Renders as:
+
+.. note:: text follows here
+
+Caution
+-------
+
+Use caution if there is any potential risk to data loss or lower performance.
+
+.. code-block:: rst
+
+   .. caution:: look out
+
+Renders as
+
+.. caution:: look out
+
+Warning
+-------
+
+Use warning if there is any potential risk to total data loss or physical danger.
+
+.. code-block:: rst
+
+   .. warning:: take care
+
+Renders as:
+
+.. warning:: take care
+
+Tip
+---
+
+This is a time-saving or performance enhancing option.
+
+.. code-block:: rst
+
+   .. tip:: here's a tip
+
+Renders as:
+
+.. tip:: here's a tip