centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-27 13:28:51 +07:00
Code Issues Packages Projects Releases Wiki Activity

Fix Edit on GitHub for templated pages, remove superfluous template, fix broken link (#865) (#891)

Browse Source 
- The "Edit on GitHub" buttons on the following pages do not work:
-
https://docs.ansible.com/ansible-core/devel/reference_appendices/config.html
(fixes #362)
-
https://docs.ansible.com/ansible-core/devel/dev_guide/collections_galaxy_meta.html
-
https://docs.ansible.com/ansible-core/devel/reference_appendices/playbooks_keywords.html
- The `docs/templates/modules_by_category.rst.j2` template is not used
anymore. My guess it was last used in Ansible 2.9.
-
https://docs.ansible.com/ansible-core/devel/playbook_guide/playbooks_loops.html#iterating-over-a-simple-list
has a broken link at the end of that paragraph: *"Check the [module
documentation](https://docs.ansible.com/ansible/2.9/modules/modules_by_category.html#modules-by-category)
to see if you can pass a list to any particular module’s parameter(s)."*
- the link points to the Ansible 2.9 docs.

(cherry picked from commit a34cc3fe85)

Co-authored-by: Sandra McCann <samccann@redhat.com>
This commit is contained in:
patchback[bot]
2023-11-30 15:50:51 -05:00
committed by GitHub
parent c595c56d69
commit ecf132893a
4 changed files with 11 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docsite/.templates/breadcrumbs.html
View File

@@ -14,10 +14,16 @@
{% elif pagename.startswith('collections/') %}
<br>
{% elif pagename == 'reference_appendices/config' %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}/{{ github_template_path }}config.rst.j2?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% elif pagename == 'reference_appendices/playbooks_keywords' %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}/{{ github_template_path }}playbooks_keywords.rst.j2?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% elif pagename == 'dev_guide/collections_galaxy_meta' %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}/{{ github_template_path }}collections_galaxy_meta.rst.j2?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% elif check_meta and pagename.startswith('cli') and meta.get('source', None) %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_cli_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_cli_version }}/{{ meta.get('source', '') }}?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% elif (not 'list_of' in pagename) and (not 'category' in pagename) %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}/{{ github_rst_path }}{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}?description=%23%23%23%23%23%20SUMMARY%0A%3C!---%20Your%20description%20here%20--%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% endif %}
{%- endif %}
{%- elif display_bitbucket %}

5
docs/docsite/rst/conf.py
View File

@@ -224,8 +224,9 @@ html_context = {
'is_eol': False,
'github_user': 'ansible',
'github_repo': 'ansible-documentation',
'github_version': 'devel/docs/docsite/rst/',
'github_module_version': 'devel/lib/ansible/modules/',
'github_version': 'devel',
'github_rst_path': 'docs/docsite/rst/',
'github_template_path': 'docs/templates/',
'github_root_dir': 'devel/lib/ansible',
'github_cli_repo': 'ansible',
'github_cli_version': 'devel',

2
docs/docsite/rst/playbook_guide/playbooks_loops.rst
View File

@@ -107,7 +107,7 @@ You can pass a list directly to a parameter for some plugins. Most of the packag
state: present
loop: "{{ list_of_packages }}"
Check the :ref:`module documentation <modules_by_category>` to see if you can pass a list to any particular module's parameter(s).
Check the :ref:`module documentation <list_of_module_plugins>` to see if you can pass a list to any particular module's parameter(s).
Iterating over a list of hashes
-------------------------------

17
docs/templates/modules_by_category.rst.j2 vendored
View File

@@ -1,17 +0,0 @@
.. _modules_by_category:
{# avoids rST "isn't included in any toctree" errors for module index docs #}
:orphan:
Module Index
============
.. toctree:: :maxdepth: 1
{% for name in categories %}
{# strip out empty category names as a result flattening the dir structure #}
{% if name %}
list_of_@{ name }@_modules
{% endif %}
{% endfor %}