Scaffold future docs structure (#3997)

Scaffold out the future doc tree structure with placeholders to be populated as time permits. --------- Co-authored-by: Sandra McCann <[email protected]>
ansible · Aug 11, 2023 · 7ff15a3 · 7ff15a3
1 parent aae8d28
commit 7ff15a3
Show file tree

Hide file tree

Showing 24 changed files with 51 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -26,3 +26,4 @@ tools/test-schema/node_modules
 site
 .DS_Store
 src/molecule/_version.py
+venv
diff --git a/docs/working/contributor_guide/code_of_conduct.md b/docs/working/contributor_guide/code_of_conduct.md
@@ -0,0 +1 @@
+# Code of conduct
diff --git a/docs/working/contributor_guide/contribution_requirements.md b/docs/working/contributor_guide/contribution_requirements.md
@@ -0,0 +1 @@
+# Contributing to molecule
diff --git a/docs/working/contributor_guide/developer_contact.md b/docs/working/contributor_guide/developer_contact.md
@@ -0,0 +1 @@
+# Developer contacts
diff --git a/docs/working/contributor_guide/environment_setup.md b/docs/working/contributor_guide/environment_setup.md
@@ -0,0 +1 @@
+# Setting up a development environment
diff --git a/docs/working/examples/example_1.md b/docs/working/examples/example_1.md
@@ -0,0 +1 @@
+# Example 1
diff --git a/docs/working/examples/example_2.md b/docs/working/examples/example_2.md
@@ -0,0 +1 @@
+# Example 2
diff --git a/docs/working/examples/example_3.md b/docs/working/examples/example_3.md
@@ -0,0 +1 @@
+# Example 3
diff --git a/docs/working/faq/faq.md b/docs/working/faq/faq.md
@@ -0,0 +1 @@
+# Frequently asked questions
diff --git a/docs/working/getting_started/getting_started.md b/docs/working/getting_started/getting_started.md
@@ -0,0 +1 @@
+# Getting started
diff --git a/docs/working/installation/install.md b/docs/working/installation/install.md
@@ -0,0 +1 @@
+# Install/Uninstall
diff --git a/docs/working/installation/upgrade.md b/docs/working/installation/upgrade.md
@@ -0,0 +1 @@
+# Upgrading
diff --git a/docs/working/introduction/introduction.md b/docs/working/introduction/introduction.md
@@ -0,0 +1 @@
+# Introduction
diff --git a/docs/working/references/cli.md b/docs/working/references/cli.md
@@ -0,0 +1 @@
+# Command line interface
diff --git a/docs/working/references/configuration.md b/docs/working/references/configuration.md
@@ -0,0 +1 @@
+# Configuration
diff --git a/docs/working/references/porting_change_log.md b/docs/working/references/porting_change_log.md
@@ -0,0 +1 @@
+# Porting and change logs
diff --git a/docs/working/references/road_map.md b/docs/working/references/road_map.md
@@ -0,0 +1 @@
+# Road map
diff --git a/docs/working/user_guide/ci_integration.md b/docs/working/user_guide/ci_integration.md
@@ -0,0 +1 @@
+# CI/CD pipeline usage
diff --git a/docs/working/user_guide/creating_testing_collection.md b/docs/working/user_guide/creating_testing_collection.md
@@ -0,0 +1 @@
+# Creating and testing a collection
diff --git a/docs/working/user_guide/testing_existing_collection.md b/docs/working/user_guide/testing_existing_collection.md
@@ -0,0 +1 @@
+# Testing an existing collection
diff --git a/docs/working/user_guide/testing_existing_roles.md b/docs/working/user_guide/testing_existing_roles.md
@@ -0,0 +1 @@
+# Testing existing roles
diff --git a/docs/working/user_guide/understanding.md b/docs/working/user_guide/understanding.md
@@ -0,0 +1 @@
+# Understanding Molecule
diff --git a/docs/working/user_guide/using_tox-ansible.md b/docs/working/user_guide/using_tox-ansible.md
@@ -0,0 +1 @@
+# Using tox-ansible
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -67,6 +67,34 @@ nav:
   - examples.md
   - faq.md
   - contributing.md
+  - Future documentation (WIP):
+      - Introduction: working/introduction/introduction.md
+      - Installation:
+          - working/installation/install.md
+          - working/installation/upgrade.md
+      - Getting Started: working/getting_started/getting_started.md
+      - User Guide:
+          - working/user_guide/understanding.md
+          - working/user_guide/creating_testing_collection.md
+          - working/user_guide/testing_existing_collection.md
+          - working/user_guide/testing_existing_roles.md
+          - working/user_guide/ci_integration.md
+          - working/user_guide/using_tox-ansible.md
+      - References:
+          - working/references/cli.md
+          - working/references/configuration.md
+          - working/references/porting_change_log.md
+          - working/references/road_map.md
+      - Examples:
+          - working/examples/example_1.md
+          - working/examples/example_2.md
+          - working/examples/example_3.md
+      - Frequently asked questions: working/faq/faq.md
+      - Contributor Guide:
+          - working/contributor_guide/code_of_conduct.md
+          - working/contributor_guide/developer_contact.md
+          - working/contributor_guide/environment_setup.md
+          - working/contributor_guide/contribution_requirements.md
 
 plugins:
   - autorefs