From cc33c10cef17070f688e62178d47f71a08bc4801 Mon Sep 17 00:00:00 2001 From: Don Naro Date: Tue, 7 Mar 2023 18:35:17 +0000 Subject: [PATCH] User content issue #17 --- data/links.yaml | 74 +++++++++++++++++++++++++------------- data/pages.yaml | 64 +++++++++++++++++++++++++++++---- templates/index.html | 8 ++--- templates/user.html | 85 +++++++++++++++++++++++++++++++++++++++++--- 4 files changed, 193 insertions(+), 38 deletions(-) diff --git a/data/links.yaml b/data/links.yaml index 51f6e62..1bacf8b 100644 --- a/data/links.yaml +++ b/data/links.yaml @@ -7,15 +7,12 @@ pkg_docs: inventory_guide: "https://docs.ansible.com/ansible/latest/inventory_guide/index.html" playbook_guide: "https://docs.ansible.com/ansible/latest/playbook_guide/index.html" developer_guide: "https://docs.ansible.com/ansible/latest/dev_guide/index.html" +# Initial major actions for personas on the index page. 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" @@ -25,26 +22,34 @@ 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" - awx_operator: "https://github.com/ansible/awx-operator" - builder: "https://ansible-builder.readthedocs.io/en/latest/" - compat: "https://ansible-compat.readthedocs.io/en/latest/" - eda: "https://github.com/ansible/eda-server" - galaxy: "https://galaxy.ansible.com/docs/" - galaxy_ng: "https://galaxyng.netlify.app/" - lint: "https://ansible-lint.readthedocs.io/en/latest/" - molecule: "https://molecule.readthedocs.io/en/latest/" - navigator: "https://ansible-navigator.readthedocs.io/en/latest/" - pinakes: "https://github.com/ansible/pinakes" - pylibssh: "https://ansible-pylibssh.readthedocs.io/en/latest/" - receptor: "https://receptor.readthedocs.io/en/latest/index.html" - rulebook: "https://ansible-rulebook.readthedocs.io/en/latest/" - runner: "https://ansible-runner.readthedocs.io/en/stable/" - sdk: "https://ansible-sdk.readthedocs.io/en/latest/" - sign: "https://ansible.github.io/ansible-sign/" - vscode: "https://marketplace.visualstudio.com/items?itemName=redhat.ansible" +# Milestone actions for the Ansible user persona. +user: + automate: + start: "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: + multiple_hosts: "https://docs.ansible.com/ansible/latest/inventory_guide/intro_inventory.html" + dynamic: "https://docs.ansible.com/ansible/latest/inventory_guide/intro_dynamic_inventory.html" + organize: + roles: "https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_reuse_roles.html" + reuse: + explore_galaxy: "https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#finding-collections-on-galaxy" + install_roles: "https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#installing-roles-from-galaxy" + install_collections: "https://docs.ansible.com/ansible/latest/galaxy/user_guide.html#installing-collections" + customize_content: "" + share: + submit_roles: "https://galaxyng.netlify.app/community/userguide/#importing-roles" + create_roles: "https://docs.ansible.com/ansible/latest/galaxy/dev_guide.html#creating-roles-for-galaxy" + create_collection: "https://docs.ansible.com/ansible/latest/galaxy/dev_guide.html#creating-collections-for-galaxy" + upload_collection: "https://galaxyng.netlify.app/community/userguide/#uploading-collections" + awx: + on_demand_jobs: "https://github.com/ansible/awx/blob/devel/docs/tasks.md#awx-jobs" + schedule_jobs: "https://github.com/ansible/awx/blob/devel/docs/schedules.md#scheduled-jobs" + create_job_templates: "" + executor: + build_ees: "https://ansible-builder.readthedocs.io/en/latest/index.html" + use_ees: "https://ansible-runner.readthedocs.io/en/latest/execution_environments/" +# Milestone actions for the developer persona. developer: start: overview: "https://docs.ansible.com/ansible/latest/dev_guide/overview_architecture.html" @@ -67,3 +72,24 @@ developer: gh_actions: "" troubleshoot: "" request_inclusion: "https://github.com/ansible-collections/ansible-inclusion" +# Documentation home pages for Ansible projects. +project_doc_home: + als: "https://als.readthedocs.io/en/latest/" + awx: "https://github.com/ansible/awx" + awx_operator: "https://github.com/ansible/awx-operator" + builder: "https://ansible-builder.readthedocs.io/en/latest/" + compat: "https://ansible-compat.readthedocs.io/en/latest/" + eda: "https://github.com/ansible/eda-server" + galaxy: "https://galaxy.ansible.com/docs/" + galaxy_ng: "https://galaxyng.netlify.app/" + lint: "https://ansible-lint.readthedocs.io/en/latest/" + molecule: "https://molecule.readthedocs.io/en/latest/" + navigator: "https://ansible-navigator.readthedocs.io/en/latest/" + pinakes: "https://github.com/ansible/pinakes" + pylibssh: "https://ansible-pylibssh.readthedocs.io/en/latest/" + receptor: "https://receptor.readthedocs.io/en/latest/index.html" + rulebook: "https://ansible-rulebook.readthedocs.io/en/latest/" + runner: "https://ansible-runner.readthedocs.io/en/stable/" + sdk: "https://ansible-sdk.readthedocs.io/en/latest/" + sign: "https://ansible.github.io/ansible-sign/" + vscode: "https://marketplace.visualstudio.com/items?itemName=redhat.ansible" diff --git a/data/pages.yaml b/data/pages.yaml index b6a8432..895f823 100644 --- a/data/pages.yaml +++ b/data/pages.yaml @@ -28,12 +28,6 @@ index: # Ansible user user_heading: Ansible users 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 more resources for Ansible users @@ -65,6 +59,64 @@ index: ecosystem: title: Ansible Ecosystem intro: Projects in the Ansible ecosystem let you expand automation to a virtually unlimited set of use cases. +# User page. +user: + title: User resources + intro: Automate the management of remote systems and control their desired state. + milestone: + automate: Create automation + build_inventory: Build inventories + organize: Organize automation projects + tooling: Use Ansible tooling + reuse: Re-use automation content + share: Share automation content + awx: Schedule and run automation jobs + executor: Embed automation in systems + automate: + intro: Write playbooks and develop content that automates complex tasks. + label: Button group that links to Ansible user documentation. + start: Start writing Ansible playbooks + evaluate_plugins: Learn which plugins to use for your tasks + build_inventory: + intro: Build inventories that list and describe your infrastructure. + label: Button group that links to user documentation for building inventories. + multiple_hosts: Build inventory files to manage multiple hosts + dynamic: Use dynamic inventories + organize: + intro: Organize your automation project as it grows. + label: Button group that links to user documentation for organizing automation projects. + roles: Use roles to structure the automation project + tooling: + intro: Validate and improve your project for consistent, trusted automation. + label: Button group that links to user documentation for validating automation content. + lint: Use Ansible Lint to validate playbooks + molecule: Install Molecule to develop and test Ansible roles + navigator: Create and test playbooks with Ansible Navigator + vscode: Use Ansible with Visual Studio Code and OpenVSX compatible editors + reuse: + intro: Re-use existing automation content. + label: Button group that links to user documentation for re-using automation content. + explore_galaxy: Start exploring Ansible Galaxy + install_roles: Install and use roles + install_collections: Install and use collections + customize_content: Customize automation content + share: + intro: Share your automation content with others. + label: Button group that links to user documentation for sharing automation content. + submit_roles: Submit roles to an existing collection + create_collection: Create a new collection + upload_collection: Upload a collection to Ansible Galaxy + awx: + intro: Use AWX for more convenient automation. + label: Button group that links to user documentation for AWX. + on_demand_jobs: Execute automation jobs on demand + schedule_jobs: Schedule automation jobs + create_job_templates: Create AWX job templates + executor: + intro: Invoke automation jobs from other systems. + label: Button group that links to user documentation for executor. + build_ees: Build execution environment with specific dependencies + use_ees: Use execution environments with AWX jobs # Developer page developer: title: Developer resources diff --git a/templates/index.html b/templates/index.html index cf5e0f5..daee2d5 100644 --- a/templates/index.html +++ b/templates/index.html @@ -32,10 +32,10 @@

{{ pages.ansible_pkg.announce }}

{{ pages.index.user_heading }}

{{ pages.index.user_body }}

-
- {{ pages.index.user_actions.automate }} - {{ pages.index.user_actions.evaluate_plugins }} - {{ pages.index.user_actions.build_inventory }} +
+ {{ pages.user.automate.start }} + {{ pages.user.automate.evaluate_plugins }} + {{ pages.user.build_inventory.multiple_hosts }}
diff --git a/templates/user.html b/templates/user.html index e09399a..67447af 100644 --- a/templates/user.html +++ b/templates/user.html @@ -1,4 +1,81 @@ -{% extends "_base.html" %} -{% block body %} -

User resources go here.

-{% endblock %} \ No newline at end of file +{% extends "_base.html" %} {% block body %} +
+
+

{{ pages.user.title }}

+

{{ pages.user.intro }}

+
+
+
+
+

{{ pages.user.milestone.automate }}

+

{{ pages.user.automate.intro }}

+
+ {{ pages.user.automate.start }} + {{ pages.user.automate.evaluate_plugins }} +
+
+
+

{{ pages.user.milestone.build_inventory }}

+

{{ pages.user.build_inventory.intro }}

+
+ {{ pages.user.build_inventory.multiple_hosts }} + {{ pages.user.build_inventory.dynamic }} +
+
+
+

{{ pages.user.milestone.organize }}

+

{{ pages.user.organize.intro }}

+
+ {{ pages.user.organize.roles }} +
+
+
+

{{ pages.user.milestone.tooling }}

+

{{ pages.user.tooling.intro }}

+
+ {{ pages.user.tooling.lint }} + {{ pages.user.tooling.molecule }} + {{ pages.user.tooling.navigator }} + {{ pages.user.tooling.vscode }} +
+
+
+

{{ pages.user.milestone.reuse }}

+

{{ pages.user.reuse.intro }}

+
+ {{ pages.user.reuse.explore_galaxy }} + {{ pages.user.reuse.install_roles }} + {{ pages.user.reuse.install_collections }} + {{ pages.user.reuse.customize_content }} +
+
+
+

{{ pages.user.milestone.share }}

+

{{ pages.user.share.intro }}

+
+ {{ pages.user.share.submit_roles }} + {{ pages.user.share.create_collection }} + {{ pages.user.share.upload_collection }} +
+
+
+

{{ pages.user.milestone.awx }}

+

{{ pages.user.awx.intro }}

+
+ {{ pages.user.awx.on_demand_jobs }} + {{ pages.user.awx.schedule_jobs }} + {{ pages.user.awx.create_job_templates }} +
+
+
+

{{ pages.user.milestone.executor }}

+

{{ pages.user.executor.intro }}

+
+ {{ pages.user.executor.build_ees }} + {{ pages.user.executor.use_ees }} +
+
+
+
+
+{% endblock %}