diff --git a/data/base.yaml b/data/base.yaml index c5e734b..f1c2b29 100644 --- a/data/base.yaml +++ b/data/base.yaml @@ -1,13 +1,3 @@ site_title: Ansible Documentation site_description: Ansible Documentation site_author: Ansible Community -ansible_version: 7 -pages: - user: user.html - developer: developer.html - maintainer: maintainer.html - collections: collections.html - community: community.html - core: core.html - ecosystem: ecosystem.html - index: index.html diff --git a/data/links.yaml b/data/links.yaml index 9ca604e..9301d1e 100644 --- a/data/links.yaml +++ b/data/links.yaml @@ -1,15 +1,30 @@ core_docs: + index: "https://docs.ansible.com/ansible-core/devel/index.html" +pkg_docs: index: "https://docs.ansible.com/ansible/latest/index.html" - start: "https://docs.ansible.com/ansible/latest/getting_started/index.html" install: "https://docs.ansible.com/ansible/latest/installation_guide/index.html" + collections_index: "https://docs.ansible.com/ansible/latest/collections/all_plugins.html" inventory_guide: "https://docs.ansible.com/ansible/latest/inventory_guide/index.html" playbook_guide: "https://docs.ansible.com/ansible/latest/playbook_guide/index.html" - collections_index: "https://docs.ansible.com/ansible/latest/collections/all_plugins.html" developer_guide: "https://docs.ansible.com/ansible/latest/dev_guide/index.html" -dev_docs: - environment_setup: "https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html#environment-setup" - developing_modules: "https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html#developing-modules-general" - ansible_architecture: "https://docs.ansible.com/ansible/latest/dev_guide/overview_architecture.html" +novice_actions: + learn: "https://docs.ansible.com/ansible/latest/index.html" + setup: "" + install: "https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-and-upgrading-ansible" + start: "https://docs.ansible.com/ansible/latest/getting_started/index.html" +user_actions: + automate: "https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_intro.html#playbook-syntax" + evaluate_plugins: "https://docs.ansible.com/ansible/latest/module_plugin_guide/modules_intro.html" + build_inventory: "https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html" +developer_actions: + setup: "https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html#environment-setup" + guidelines: "https://docs.ansible.com/ansible/latest/community/getting_started.html" + start: "https://docs.ansible.com/ansible/latest/dev_guide/developing_locally.html" + learn: "https://docs.ansible.com/ansible/latest/dev_guide/overview_architecture.html" +maintainer_actions: + overview: "https://docs.ansible.com/ansible/latest/community/contributor_path.html" + learn: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html" + join: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html#weekly-community-matrix-irc-meetings" project_doc_home: als: "https://als.readthedocs.io/en/latest/" awx: "https://github.com/ansible/awx" diff --git a/data/pages.yaml b/data/pages.yaml index bd96aae..ac2d69c 100644 --- a/data/pages.yaml +++ b/data/pages.yaml @@ -1,51 +1,67 @@ +# Latest Ansible package version. +ansible_pkg: + announce: Ansible 7 is now available + pip_install: pip install ansible +# Base docsite page names. +site: + index: index.html + user: user.html + developer: developer.html + maintainer: maintainer.html + collections: collections.html + community: community.html + core: core.html + ecosystem: ecosystem.html +# Content for the index page. index: welcome: Welcome to Ansible documentation about_ansible: Ansible offers powerful and flexible automation that is simple, decentralized, and easy. - #Ansible novice + # Ansible novice novice_actions: - #Labels provide meaningful descriptions of elements for accessibility purposes. - action_label: Button group that links to documentation for new Ansible users. - action_one: Understand the fundamentals of Ansible automation - action_two: Set up an Ansible automation project - action_three: Write your first playbook in a few easy steps - #Ansible installation - install_action: Go to the installation guide - #Ansible user + # Labels provide meaningful descriptions of elements for accessibility purposes. + label: Button group that links to documentation for new Ansible users. + learn: Understand the fundamentals of Ansible automation + install: Install the Ansible package + start: Write your first playbook in a few easy steps + # Ansible installation + install_action: Find more installation options + # Ansible user user_heading: Ansible users - user_base_body: Ansible playbooks are blueprints for automating software deployment and system configuration as well as orchestrating complex operations. - user_base_actions: - #Labels provide meaningful descriptions of elements for accessibility purposes. - action_label: Button group that links to base Ansible user documentation. - action_one: Start writing Ansible playbooks - action_two: Learn which plugins to use for your tasks - action_three: Build inventory files to manage multiple hosts + user_body: Ansible playbooks are blueprints for automating software deployment and system configuration as well as orchestrating complex operations. + user_actions: + # Labels provide meaningful descriptions of elements for accessibility purposes. + label: Button group that links to base Ansible user documentation. + automate: Start writing Ansible playbooks + evaluate_plugins: Learn which plugins to use for your tasks + build_inventory: Build inventory files to manage multiple hosts user_resources_heading: User resources user_resources_body: Structure your project with roles, improve content quality, re-use existing automation, and more. - user_resources_action: Find user resources - #Ansible developer + user_resources_action: Find more resources for Ansible users + # Ansible developer developer_heading: Ansible developers - developer_base_body: Ansible is open source. You can add code that fixes bugs, implements new features, or extends the benefits of simple, agentless automation. - developer_base_actions: - #Labels provide meaningful descriptions of elements for accessibility purposes. - action_label: Button group that links to base Ansible developer documentation. - action_one: Set up your development environment - action_two: Review the Ansible contributor guidelines - action_three: Write custom modules or plugins + developer_body: Ansible is open source. You can add code that fixes bugs, implements new features, or extends the benefits of simple, agentless automation. + developer_actions: + # Labels provide meaningful descriptions of elements for accessibility purposes. + label: Button group that links to base Ansible developer documentation. + setup: Set up your development environment + guidelines: Review the Ansible contributor guidelines + start: Write custom modules or plugins developer_resources_heading: Developer resources developer_resources_body: Contribute to an Ansible project or collection, run sanity tests, write integration and unit tests, and more. - developer_resources_action: Find developer resources - #Community maintainer + developer_resources_action: Find more resources for developing with Ansible + # Community maintainer maintainer_heading: Community maintainers - maintainer_base_body: Ansible maintainers are responsible for the ongoing quality of Ansible projects and collections and play a vital role in guiding the direction of the wider community. - maintainer_base_actions: - #Labels provide meaningful descriptions of elements for accessibility purposes. - action_label: Button group that links to base Ansible community maintainer documentation. - action_one: Learn about the Ansible community - action_two: Review and agree to the code of conduct - action_three: Join or start a discussion that interests you + maintainer_body: Ansible maintainers are responsible for the ongoing quality of Ansible projects and collections and play a vital role in guiding the direction of the wider community. + maintainer_actions: + # Labels provide meaningful descriptions of elements for accessibility purposes. + label: Button group that links to base Ansible community maintainer documentation. + overview: Understand Ansible contributor paths + learn: Learn about community maintainer responsibilities + join: Join or start a discussion that interests you maintainer_resources_heading: Community maintainer resources maintainer_resources_body: Handle project lifecycles, ensure the health of collections, join the Ansible steering committee, and more. - maintainer_resources_action: Find maintainer resources + maintainer_resources_action: Find more resources for Ansible community maintainers +# Ansible ecosystem page. ecosystem: title: Ansible Ecosystem - intro: Projects in the Ansible ecosystem let you expand automation to a virtually unlimited set of use cases. \ No newline at end of file + intro: Projects in the Ansible ecosystem let you expand automation to a virtually unlimited set of use cases. diff --git a/templates/index.html b/templates/index.html index 8bda194..cf5e0f5 100644 --- a/templates/index.html +++ b/templates/index.html @@ -8,21 +8,21 @@

{{ pages.index.welcome }}

{{ pages.index.about_ansible }}

-
- {{ pages.index.novice_actions.action_one }} - {{ pages.index.novice_actions.action_two }} - {{ pages.index.novice_actions.action_three }} +
+ {{ pages.index.novice_actions.learn }} + {{ pages.index.novice_actions.install }} + {{ pages.index.novice_actions.start }}
-

Ansible {{ base.ansible_version }} is now available

+

{{ pages.ansible_pkg.announce }}

-
pip install ansible
+
{{ pages.ansible_pkg.pip_install }}
- {{ pages.index.install_action }} + {{ pages.index.install_action }}
@@ -31,11 +31,11 @@

Ansible {{ base.ansible_version }} is now available

{{ pages.index.user_heading }}
-

{{ pages.index.user_base_body }}

-
@@ -43,7 +43,7 @@
{{ pages.index.user_heading }}
{{ pages.index.user_resources_heading }}

{{ pages.index.user_resources_body }}

- {{ pages.index.user_resources_action }} + {{ pages.index.user_resources_action }}
@@ -52,11 +52,11 @@
{{ pages.index.user_resources_heading }}
{{ pages.index.developer_heading }}
-

{{ pages.index.developer_base_body }}

-
@@ -64,7 +64,7 @@
{{ pages.index.developer_heading }}
{{ pages.index.developer_resources_heading }}

{{ pages.index.developer_resources_body }}

- {{ pages.index.developer_resources_action }} + {{ pages.index.developer_resources_action }}
@@ -73,11 +73,11 @@
{{ pages.index.developer_resources_heading }}
{{ pages.index.maintainer_heading }}
-

{{ pages.index.maintainer_base_body }}

-
@@ -85,7 +85,7 @@
{{ pages.index.maintainer_heading }} <
{{ pages.index.maintainer_resources_heading }}

{{ pages.index.maintainer_resources_body }}

- {{ pages.index.maintainer_resources_action }} + {{ pages.index.maintainer_resources_action }}