Skip to content
This repository has been archived by the owner on Oct 10, 2023. It is now read-only.

Commit

Permalink
add user journeys (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
@oraNod
oraNod authored Mar 10, 2023
1 parent 3968c49 commit 9bd3a5d
Show file tree
Hide file tree
Showing 4 changed files with 194 additions and 50 deletions.
75 changes: 51 additions & 24 deletions data/links.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,40 @@ 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"
# Novice actions
novice:
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"
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"
# User actions
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"
find:
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:
create_roles: "https://docs.ansible.com/ansible/latest/dev_guide/migrating_roles.html"
create_collection: "https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html#developing-collections"
submit_roles: "https://galaxyng.netlify.app/community/userguide/#importing-roles"
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/"
# Developer actions
developer:
start:
setup: "https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html#environment-setup"
Expand All @@ -59,6 +64,7 @@ developer:
gh_actions: ""
troubleshoot: ""
request_inclusion: "https://github.com/ansible-collections/ansible-inclusion"
# Community maintainer actions
maintainer:
learn:
guidelines: "https://docs.ansible.com/ansible/latest/community/maintainers_guidelines.html"
Expand All @@ -74,3 +80,24 @@ maintainer:
review: "https://github.com/ansible-collections/ansible-inclusion/blob/main/README.md#review-process"
participate:
join: "https://docs.ansible.com/ansible/latest/community/contributor_path.html#become-a-steering-committee-member"
# Documentation home pages
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"
80 changes: 61 additions & 19 deletions data/pages.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Latest Ansible package version.
# Latest Ansible package version
ansible_pkg:
announce: Ansible 7 is now available
pip_install: pip install ansible
# Base docsite page names.
# Base docsite page names
site:
index: index.html
user: user.html
Expand All @@ -12,7 +12,7 @@ site:
community: community.html
core: core.html
ecosystem: ecosystem.html
# Content for the index page.
# 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.
Expand All @@ -21,10 +21,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:
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
Expand All @@ -40,16 +36,62 @@ index:
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 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.
# Resources for Ansible novice journeys
# Actions for novice journeys
novice:
learn: Understand the fundamentals of Ansible automation
install: Install the Ansible package
start: Write your first playbook in a few easy steps
# Developer page
# Actions for user journeys
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
find: Find 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.
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.
multiple_hosts: Build inventory files to manage multiple hosts
dynamic: Use dynamic inventories
organize:
intro: Organize your automation project as it grows.
roles: Use roles to structure the automation project
tooling:
intro: Validate and improve your project for consistent, trusted automation.
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
find:
intro: Discover and use existing 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.
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.
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.
build_ees: Build execution environment with specific dependencies
use_ees: Use execution environments with AWX jobs
# Actions for developer journeys
developer:
title: Developer resources
intro: Extend automation with custom Ansible modules, add functionality to existing modules, or fix bugs to improve existing code.
Expand Down Expand Up @@ -84,7 +126,7 @@ developer:
gh_actions: Use GitHub actions to set up testing workflows
troubleshoot: Troubleshoot collections with ansible-navigator
request_inclusion: Request a collection be added to the Ansible package
# Resources for community maintainer journeys.
# Actions for community maintainer journeys
maintainer:
title: Ansible community maintainers
intro: Community maintainers are trusted contributors who oversee project lifecycle and overall health.
Expand All @@ -95,26 +137,26 @@ maintainer:
participate: Participate in cross-project governance
learn:
intro: Interested in becoming a community maintainer? Find out what's involved.
label: Button group that links to Ansible community maintainer documentation.
guidelines: Review community maintainer responsibilities
backports: Backport merged pull requests to stable branches
release: Regularly release stable versions
documentation: Look after collection documentation
build_community:
intro: Community maintainers play a special role to enable and encourage contributors.
label: Button group that links to base Ansible community maintainer documentation.
communication: Join or start a community discussion
contributor_paths: Understand Ansible contributor paths
encourage: Attract and mentor new contributors
collection_inclusion:
intro: Satisfy requirements to get collections included in the Ansible package.
label: Button group that links to Ansible community maintainer documentation.
process: Understand the inclusion process
review: Go through inclusion review cycles
participate:
intro: Get involved in higher-level decision processes that guide the broader community.
label: Button group that links to Ansible community maintainer documentation.
join: Join the Ansible steering committee
# Ansible ecosystem
ecosystem:
title: Ansible Ecosystem
intro: Projects in the Ansible ecosystem let you expand automation to a virtually unlimited set of use cases.
# Labels provide meaningful descriptions of elements for accessibility purposes.
labels:
button_group: Button group that links to Ansible community documentation.
button_group: Button group that links to Ansible community documentation.
6 changes: 3 additions & 3 deletions templates/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ <h4>{{ pages.ansible_pkg.announce }}</h4>
<h5>{{ pages.index.user_heading }} <i class="fas fa-cogs"></i></h5>
<p class="card-text">{{ pages.index.user_body }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.user_actions.automate }}" role="button">{{ pages.index.user_actions.automate }}</a>
<a class="btn btn-primary" href="{{ links.user_actions.evaluate_plugins }}" role="button">{{ pages.index.user_actions.evaluate_plugins }}</a>
<a class="btn btn-primary" href="{{ links.user_actions.build_inventory }}" role="button">{{ pages.index.user_actions.build_inventory }}</a>
<a class="btn btn-primary" href="{{ links.user.automate.start }}" role="button">{{ pages.user.automate.start }}</a>
<a class="btn btn-primary" href="{{ links.user.automate.evaluate_plugins }}" role="button">{{ pages.user.automate.evaluate_plugins }}</a>
<a class="btn btn-primary" href="{{ links.user.build_inventory.multiple_hosts }}" role="button">{{ pages.user.build_inventory.multiple_hosts }}</a>
</div>
</div>
</div>
Expand Down
83 changes: 79 additions & 4 deletions templates/user.html
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,79 @@
{% extends "_base.html" %}
{% block body %}
<p>User resources go here.</p>
{% endblock %}
{% extends "_base.html" %} {% block body %}
<div class="container">
<div class="page-title">
<h2>{{ pages.user.title }}</h2>
<p>{{ pages.user.intro }}</p>
</div>
<div class="full-width-bg component">
<div class="grid-wrapper">
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.user.milestone.automate }}</h3>
<p>{{ pages.user.automate.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.user.automate.start }}" role="button">{{ pages.user.automate.start }}</a>
<a class="btn btn-primary" href="{{ links.user.automate.evaluate_plugins }}" role="button">{{ pages.user.automate.evaluate_plugins }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.user.milestone.build_inventory }}</h3>
<p>{{ pages.user.build_inventory.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.user.build_inventory.multiple_hosts }}" role="button">{{ pages.user.build_inventory.multiple_hosts }}</a>
<a class="btn btn-primary" href="{{ links.user.build_inventory.dynamic }}" role="button">{{ pages.user.build_inventory.dynamic }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.user.milestone.organize }}</h3>
<p>{{ pages.user.organize.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.user.organize.roles }}" role="button">{{ pages.user.organize.roles }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.user.milestone.tooling }}</h3>
<p>{{ pages.user.tooling.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.project_doc_home.lint }}" role="button">{{ pages.user.tooling.lint }}</a>
<a class="btn btn-primary" href="{{ links.project_doc_home.molecule }}" role="button">{{ pages.user.tooling.molecule }}</a>
<a class="btn btn-primary" href="{{ links.project_doc_home.navigator }}" role="button">{{ pages.user.tooling.navigator }}</a>
<a class="btn btn-primary" href="{{ links.project_doc_home.vscode }}" role="button">{{ pages.user.tooling.vscode }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.user.milestone.find }}</h3>
<p>{{ pages.user.find.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.user.find.explore_galaxy }}" role="button">{{ pages.user.find.explore_galaxy }}</a>
<a class="btn btn-primary" href="{{ links.user.find.install_roles }}" role="button">{{ pages.user.find.install_roles }}</a>
<a class="btn btn-primary" href="{{ links.user.find.install_collections }}" role="button">{{ pages.user.find.install_collections }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.user.milestone.share }}</h3>
<p>{{ pages.user.share.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.user.share.submit_roles }}" role="button">{{ pages.user.share.submit_roles }}</a>
<a class="btn btn-primary" href="{{ links.user.share.create_collection }}" role="button">{{ pages.user.share.create_collection }}</a>
<a class="btn btn-primary" href="{{ links.user.share.upload_collection }}" role="button">{{ pages.user.share.upload_collection }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.user.milestone.awx }}</h3>
<p>{{ pages.user.awx.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.user.awx.on_demand_jobs }}" role="button">{{ pages.user.awx.on_demand_jobs }}</a>
<a class="btn btn-primary" href="{{ links.user.awx.schedule_jobs }}" role="button">{{ pages.user.awx.schedule_jobs }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.user.milestone.executor }}</h3>
<p>{{ pages.user.executor.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.user.executor.build_ees }}" role="button">{{ pages.user.executor.build_ees }}</a>
<a class="btn btn-primary" href="{{ links.user.executor.use_ees }}" role="button">{{ pages.user.executor.use_ees }}</a>
</div>
</div>
</div>
</div>
</div>
{% endblock %}

0 comments on commit 9bd3a5d

Please sign in to comment.