Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Scaffold future docs structure #3997

Merged
merged 5 commits into from
Aug 11, 2023
Merged

Scaffold future docs structure #3997

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
88c9c90
Scaffold future docs structure
cidrblock Aug 10, 2023
1b635c6
lint fixes
cidrblock Aug 10, 2023
35198ca
EOL
cidrblock Aug 10, 2023
6a27758
Update docs/working/user_guide/understanding.md
cidrblock Aug 11, 2023
13b9a87
Update tree
cidrblock Aug 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@ tools/test-schema/node_modules
site
.DS_Store
src/molecule/_version.py
venv
1 change: 1 addition & 0 deletions docs/working/contributor_guide/code_of_conduct.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Code of conduct
1 change: 1 addition & 0 deletions docs/working/contributor_guide/contribution_requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Contributing to molecule
1 change: 1 addition & 0 deletions docs/working/contributor_guide/developer_contact.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Developer contacts
1 change: 1 addition & 0 deletions docs/working/contributor_guide/environment_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Setting up a development environment
1 change: 1 addition & 0 deletions docs/working/examples/example_1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Example 1
cidrblock marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions docs/working/examples/example_2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Example 2
1 change: 1 addition & 0 deletions docs/working/examples/example_3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Example 3
1 change: 1 addition & 0 deletions docs/working/faq/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Frequently asked questions
1 change: 1 addition & 0 deletions docs/working/getting_started/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Getting started
1 change: 1 addition & 0 deletions docs/working/installation/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Install/Uninstall
1 change: 1 addition & 0 deletions docs/working/installation/upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Upgrading
1 change: 1 addition & 0 deletions docs/working/introduction/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Introduction
1 change: 1 addition & 0 deletions docs/working/references/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Command line interface
1 change: 1 addition & 0 deletions docs/working/references/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configuration
1 change: 1 addition & 0 deletions docs/working/references/porting_change_log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Porting and change logs
1 change: 1 addition & 0 deletions docs/working/references/road_map.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Road map
1 change: 1 addition & 0 deletions docs/working/user_guid/ci_integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# CI/CD pipeline usage
1 change: 1 addition & 0 deletions docs/working/user_guid/using_tox-ansible.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Using tox-ansible
1 change: 1 addition & 0 deletions docs/working/user_guide/creating_testing_collection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Creating and testing a collection
1 change: 1 addition & 0 deletions docs/working/user_guide/testing_existing_collection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Testing an existing collection
1 change: 1 addition & 0 deletions docs/working/user_guide/testing_existing_roles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Testing existing roles
1 change: 1 addition & 0 deletions docs/working/user_guide/understanding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Concepts
cidrblock marked this conversation as resolved.
Show resolved Hide resolved
28 changes: 28 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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_guid/ci_integration.md
- working/user_guid/using_tox-ansible.md
cidrblock marked this conversation as resolved.
Show resolved Hide resolved
- 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
cidrblock marked this conversation as resolved.
Show resolved Hide resolved
- 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
Expand Down
Loading