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

Commit

Permalink
simplify pages yaml (#40)
Browse files Browse the repository at this point in the history
  • Loading branch information
oraNod authored Mar 8, 2023
1 parent 453fe14 commit 7b47057
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 29 deletions.
2 changes: 1 addition & 1 deletion data/links.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ 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"
Expand Down
23 changes: 8 additions & 15 deletions data/pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,12 @@ site:
index:
welcome: Welcome to Ansible documentation
about_ansible: Ansible offers powerful and flexible automation that is simple, decentralized, and easy.
# Ansible novice
novice_actions:
# 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_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
Expand All @@ -47,8 +38,6 @@ index:
maintainer_heading: Community maintainers
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
Expand All @@ -59,6 +48,11 @@ index:
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
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
developer:
title: Developer resources
Expand All @@ -69,32 +63,31 @@ developer:
test: Test plugins and modules
create_collection: Create new collections
start:
label: Button group that links to starting developer documentation.
intro: Ready to start writing code for Ansible? Follow these steps to get started.
setup: Set up your development environment
conduct: Review the Ansible contributor guidelines
learn: Understand the Ansible architecture
code: Write custom modules or plugins
contribute:
intro: Contribute your code to an Ansible project or collection.
label: Button group that links to developer contribution documentation.
checklist: Contribute your module to an existing collection
lifecycle: Review the lifecycle of an Ansible module or plugin
review: Review issues and PRs in an Ansible project
fix: Fix issues and implement new features in an Ansible project, collection, or module
test:
intro: Test Ansible to help fix bugs and enforce coding standards and requirements.
label: Button group that links to test documentation.
learn: Understand testing in Ansible
run: Run sanity tests
integration: Write integration tests
unit: Write unit tests
create_collection:
intro: Create a new collection that distributes Ansible content for specific use cases.
label: Button group that links to documentation for creating collections.
skeleton: Set things up with the collection skeleton
test: Test your collection for code quality
distribute: Publish your collection on a distribution server
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
# Labels provide meaningful descriptions of elements for accessibility purposes.
labels:
button_group: Button group that links to Ansible community documentation.
10 changes: 4 additions & 6 deletions templates/developer.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ <h2>{{ pages.developer.title }}</h2>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.developer.milestone.start }}</h3>
<p>{{ pages.developer.start.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.developer.start.label }}">
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.developer.start.setup }}" role="button">{{ pages.developer.start.setup }}</a>
<a class="btn btn-primary" href="{{ links.developer.start.conduct }}" role="button">{{ pages.developer.start.conduct }}</a>
<a class="btn btn-primary" href="{{ links.developer.start.learn }}" role="button">{{ pages.developer.start.learn }}</a>
Expand All @@ -19,16 +19,15 @@ <h3>{{ pages.developer.milestone.start }}</h3>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.developer.milestone.contribute }}</h3>
<p>{{ pages.developer.contribute.intro }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.developer.contribute.label }}">
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.developer.contribute.checklist }}" role="button">{{ pages.developer.contribute.checklist }}</a>
<a class="btn btn-primary" href="{{ links.developer.contribute.lifecycle }}" role="button">{{ pages.developer.contribute.lifecycle }}</a>
</div>
</div>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.developer.milestone.test }}</h3>
<p>{{ pages.developer.test.intro }}</p>
<div class="btn-group-vertical" role="group"
aria-label="{{ pages.developer.test.label }}">
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.developer.test.learn }}" role="button">{{ pages.developer.test.learn }}</a>
<a class="btn btn-primary" href="{{ links.developer.test.run }}" role="button">{{ pages.developer.test.run }}</a>
<a class="btn btn-primary" href="{{ links.developer.test.integration }}" role="button">{{ pages.developer.test.integration }}</a>
Expand All @@ -38,8 +37,7 @@ <h3>{{ pages.developer.milestone.test }}</h3>
<div class="width-6-12 width-12-12-m">
<h3>{{ pages.developer.milestone.create_collection }}</h3>
<p>{{ pages.developer.create_collection.intro }}</p>
<div class="btn-group-vertical" role="group"
aria-label="{{ pages.developer.create_collection.label }}">
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.developer.create_collection.skeleton }}" role="button">{{ pages.developer.create_collection.skeleton }}</a>
<a class="btn btn-primary" href="{{ links.developer.create_collection.test }}" role="button">{{ pages.developer.create_collection.test }}</a>
<a class="btn btn-primary" href="{{ links.developer.create_collection.distribute }}" role="button">{{ pages.developer.create_collection.distribute }}</a>
Expand Down
14 changes: 7 additions & 7 deletions templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
<h4>{{ pages.index.welcome }}</h4>
<p class="card-text">{{ pages.index.about_ansible }}</p>
<!--Start novice section-->
<div class="btn-group-vertical" role="group" aria-label="{{ pages.index.novice_actions.label }}">
<a class="btn btn-primary" href="{{ links.novice_actions.learn }}" role="button">{{ pages.index.novice_actions.learn }}</a>
<a class="btn btn-primary" href="{{ links.novice_actions.install }}" role="button">{{ pages.index.novice_actions.install }}</a>
<a class="btn btn-primary" href="{{ links.novice_actions.start }}" role="button">{{ pages.index.novice_actions.start }}</a>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.novice.learn }}" role="button">{{ pages.novice.learn }}</a>
<a class="btn btn-primary" href="{{ links.novice.install }}" role="button">{{ pages.novice.install }}</a>
<a class="btn btn-primary" href="{{ links.novice.start }}" role="button">{{ pages.novice.start }}</a>
</div>
</div>
</div>
Expand All @@ -32,7 +32,7 @@ <h4>{{ pages.ansible_pkg.announce }}</h4>
<div class="card-body">
<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.index.user_actions.label }}">
<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>
Expand All @@ -53,7 +53,7 @@ <h5>{{ pages.index.user_resources_heading }}</h5>
<div class="card-body">
<h5>{{ pages.index.developer_heading }} <i class="fas fa-code"></i></h5>
<p class="card-text">{{ pages.index.developer_body }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.developer.start.label }}">
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.developer.start.setup }}" role="button">{{ pages.developer.start.setup }}</a>
<a class="btn btn-primary" href="{{ links.developer.start.conduct }}" role="button">{{ pages.developer.start.conduct }}</a>
<a class="btn btn-primary" href="{{ links.developer.start.code }}" role="button">{{ pages.developer.start.code }}</a>
Expand All @@ -74,7 +74,7 @@ <h5>{{ pages.index.developer_resources_heading }}</h5>
<div class="card-body">
<h5>{{ pages.index.maintainer_heading }} <i class="fas fa-project-diagram"></i></h5>
<p class="card-text">{{ pages.index.maintainer_body }}</p>
<div class="btn-group-vertical" role="group" aria-label="{{ pages.index.maintainer_actions.label }}">
<div class="btn-group-vertical" role="group" aria-label="{{ pages.labels.button_group }}">
<a class="btn btn-primary" href="{{ links.maintainer_actions.overview }}" role="button">{{ pages.index.maintainer_actions.overview}}</a>
<a class="btn btn-primary" href="{{ links.maintainer_actions.learn }}" role="button">{{ pages.index.maintainer_actions.learn }}</a>
<a class="btn btn-primary" href="{{ links.maintainer_actions.join }}" role="button">{{ pages.index.maintainer_actions.join }}</a>
Expand Down

0 comments on commit 7b47057

Please sign in to comment.