Restructure docs

ansible · Dec 1, 2023 · ea11a5f · ea11a5f
1 parent fdab679
commit ea11a5f
Show file tree

Hide file tree

Showing 39 changed files with 44 additions and 89 deletions.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,16 +1,11 @@
-# Contributing
-
-- To see what's discussed see the [discussions
-  ](https://github.com/ansible-community/molecule/discussions).
-- Join the Molecule [community working
-  group](https://github.com/ansible/community/wiki/molecule) if you
-  would like to influence the direction of the project.
-- Join us in `#ansible-devtools` on
-  [libera.chat](https://web.libera.chat/?channel=#ansible-molecule) matrix/irc,
-  or [molecule discussions](https://github.com/ansible-community/molecule/discussions).
-- The full list of Ansible email lists and IRC channels can be found in
-  the [communication
-  page](https://docs.ansible.com/ansible/latest/community/communication.html).
+# Contributor Guide
+
+## Code Of Conduct
+
+Please see our [Code of
+Conduct](https://github.com/ansible-community/molecule/blob/main/.github/CODE_OF_CONDUCT.md)
+document.
+
 
 ## Guidelines
 
@@ -29,11 +24,7 @@
 - Reformat the code by following the formatting section below.
 - Submit a pull request.
 
-## Code Of Conduct
 
-Please see our [Code of
-Conduct](https://github.com/ansible-community/molecule/blob/main/.github/CODE_OF_CONDUCT.md)
-document.
 
 ## Pull Request and Governance
 

diff --git a/docs/docker.md → docs/examples/docker.md b/docs/docker.md → docs/examples/docker.md
diff --git a/docs/kubevirt.md → docs/examples/kubevirt.md b/docs/kubevirt.md → docs/examples/kubevirt.md
diff --git a/docs/podman.md → docs/examples/podman.md b/docs/podman.md → docs/examples/podman.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -114,24 +114,24 @@ The `molecule.yml` is for configuring Molecule. It is a
 [YAML](https://yaml.org/) file whose keys represent the high-level
 components that Molecule provides. These are:
 
-- The [dependency](configuration.md#dependency) manager. Molecule
+- The [dependency](references/configuration.md#dependency) manager. Molecule
   uses [galaxy development guide]
   by default to resolve your role dependencies.
-- The [driver](configuration.md#driver) provider. Molecule uses
-  the [Delegated](configuration.md#delegated) driver by default.
+- The [driver](references/configuration.md#driver) provider. Molecule uses
+  the [Delegated](references/configuration.md#delegated) driver by default.
   Molecule uses the driver to delegate the task of creating instances.
-- The [platforms](configuration.md#platforms) definitions. Molecule
+- The [platforms](references/configuration.md#platforms) definitions. Molecule
   relies on this to know which instances to create, name and to which
   group each instance belongs. If you need to test your role against
   multiple popular distributions (CentOS, Fedora, Debian), you can
   specify that in this section.
-- The [provisioner](configuration.md#provisioner). Molecule only
+- The [provisioner](references/configuration.md#provisioner). Molecule only
   provides an Ansible provisioner. Ansible manages the life cycle of
   the instance based on this configuration.
 - The [scenario][] definition.
   Molecule relies on this configuration to control the scenario
   sequence order.
-- The [verifier](configuration.md#verifier) framework. Molecule
+- The [verifier](references/configuration.md#verifier) framework. Molecule
   uses Ansible by default to provide a way to write specific state
   checking tests (such as deployment smoke tests) on the target
   instance.

diff --git a/docs/configuration.md → docs/references/configuration.md b/docs/configuration.md → docs/references/configuration.md
diff --git a/docs/faq.md → docs/references/faq.md b/docs/faq.md → docs/references/faq.md
@@ -57,7 +57,7 @@ the scenario's molecule.yml.
 
 ## Can I run Molecule processes in parallel?
 
-Please see [parallel-usage-example](examples.md#docker-with-non-privileged-user) for
+Please see [parallel-usage-example](../user_guide/examples.md#docker-with-non-privileged-user) for
 usage.
 
 ## Can I specify random instance IDs in my molecule.yml?
@@ -95,7 +95,7 @@ Yes, roles contained in a
 [monorepo](https://en.wikipedia.org/wiki/Monorepo) with other roles are
 automatically picked up and `ANSIBLE_ROLES_PATH` is set accordingly. See
 [this
-page](examples.md#monolith-repo)
+page](../user_guide/examples.md#monolith-repo)
 for more information.
 
 ## How can I add development/testing-only dependencies?

diff --git a/docs/references/porting_guide.md b/docs/references/porting_guide.md
@@ -0,0 +1 @@
+# Porting Guide
diff --git a/docs/next.md → docs/references/roadmap.md b/docs/next.md → docs/references/roadmap.md
@@ -1,6 +1,6 @@
-# Molecule Next
+# Molecule Roadmap
 
-Molecule "next" is the future major version of molecule, one that is currently
+The Molecule roadmap is the future major version of molecule, one that is currently
 available from the main branch. One of the main goals of the new version is to
 reduce the amount of magic and just rely on ansible core features.
 

diff --git a/docs/usage.md → docs/references/usage.md b/docs/usage.md → docs/references/usage.md
diff --git a/docs/working/installation/upgrade.md → docs/upgrade.md b/docs/working/installation/upgrade.md → docs/upgrade.md
diff --git a/docs/ci.md → docs/user_guide/ci.md b/docs/ci.md → docs/user_guide/ci.md
diff --git a/docs/examples.md → docs/user_guide/examples.md b/docs/examples.md → docs/user_guide/examples.md
diff --git a/docs/user_guide/testing_collections.md b/docs/user_guide/testing_collections.md
@@ -0,0 +1 @@
+# Testing roles in a collection
diff --git a/docs/user_guide/testing_roles.md b/docs/user_guide/testing_roles.md
@@ -0,0 +1 @@
+# Testing standalone roles
diff --git a/docs/user_guide/understanding.md b/docs/user_guide/understanding.md
@@ -0,0 +1 @@
+# Understanding Ansible Molecule
diff --git a/docs/user_guide/using_tox_ansible.md b/docs/user_guide/using_tox_ansible.md
@@ -0,0 +1 @@
+# Using Molecule with tox-ansible
diff --git a/docs/working/contributor_guide/code_of_conduct.md b/docs/working/contributor_guide/code_of_conduct.md
diff --git a/docs/working/contributor_guide/contribution_requirements.md b/docs/working/contributor_guide/contribution_requirements.md
diff --git a/docs/working/contributor_guide/developer_contact.md b/docs/working/contributor_guide/developer_contact.md
diff --git a/docs/working/contributor_guide/environment_setup.md b/docs/working/contributor_guide/environment_setup.md
diff --git a/docs/working/examples/example_1.md b/docs/working/examples/example_1.md
diff --git a/docs/working/examples/example_2.md b/docs/working/examples/example_2.md
diff --git a/docs/working/examples/example_3.md b/docs/working/examples/example_3.md
diff --git a/docs/working/faq/faq.md b/docs/working/faq/faq.md
diff --git a/docs/working/getting_started/getting_started.md b/docs/working/getting_started/getting_started.md
diff --git a/docs/working/installation/install.md b/docs/working/installation/install.md
diff --git a/docs/working/introduction/introduction.md b/docs/working/introduction/introduction.md
diff --git a/docs/working/references/cli.md b/docs/working/references/cli.md
diff --git a/docs/working/references/configuration.md b/docs/working/references/configuration.md
diff --git a/docs/working/references/porting_change_log.md b/docs/working/references/porting_change_log.md
diff --git a/docs/working/references/road_map.md b/docs/working/references/road_map.md
diff --git a/docs/working/user_guide/ci_integration.md b/docs/working/user_guide/ci_integration.md
diff --git a/docs/working/user_guide/creating_testing_collection.md b/docs/working/user_guide/creating_testing_collection.md
diff --git a/docs/working/user_guide/testing_existing_collection.md b/docs/working/user_guide/testing_existing_collection.md
diff --git a/docs/working/user_guide/testing_existing_roles.md b/docs/working/user_guide/testing_existing_roles.md
diff --git a/docs/working/user_guide/understanding.md b/docs/working/user_guide/understanding.md
diff --git a/docs/working/user_guide/using_tox-ansible.md b/docs/working/user_guide/using_tox-ansible.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -35,49 +35,29 @@ extra:
       link: https://github.com/ansible-community/molecule
 
 nav:
-  - Home: index.md
-  - installation.md
-  - Using:
-      - getting-started.md
-      - usage.md
-      - next.md
-      - configuration.md
-      - ci.md
+  - Introduction: index.md
+  - Installation:
+      - installation.md
+      - upgrade.md
+  - Getting Started Guide: getting-started.md
+  - User Guide:
+      - user_guide/understanding.md
+      - user_guide/testing_collections.md
+      - user_guide/testing_roles.md
+      - user_guide/ci.md
+      - user_guide/using_tox_ansible.md
+      - user_guide/examples.md
   - Examples:
-      - docker.md
-      - podman.md
-      - kubevirt.md
-  - examples.md
-  - faq.md
+      - examples/docker.md
+      - examples/podman.md
+      - examples/kubevirt.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
+  - References:
+      - references/usage.md
+      - references/configuration.md
+      - references/faq.md
+      - references/porting_guide.md
+      - references/roadmap.md
 
 plugins:
   - autorefs