amazon.aws
amazon.aws copied to clipboard
ansible-collections
Documentation for v 3.5.0 for ansible 6 doesn't fit in Brave browser, horizontally
Summary
Documentation for v 3.5.0 for ansible 6 doesn't fit in Brave browser, horizontally. It does fit OK in Firefox on my system. Turning off Brave shields doesn't affect it.
Issue Type
Documentation Report
Component Name
amazon.aws.ec2_instance
Ansible Version
$ ansible --version
ansible [core 2.13.2]
config file = /home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg
configured module search path = ['/home/bryant/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
ansible python module location = /home/bryant/.pyenv/versions/3.10.0/envs/ansible-deploy-vst/lib/python3.10/site-packages/ansible
ansible collection location = /home/bryant/.ansible/collections:/usr/share/ansible/collections
executable location = /home/bryant/.pyenv/versions/ansible-deploy-vst/bin/ansible
python version = 3.10.0 (default, Nov 2 2021, 13:53:11) [GCC 9.3.0]
jinja version = 3.1.2
libyaml = False
Collection Versions
$ ansible-galaxy collection list
Collection Version
----------------- -------
amazon.aws 4.2.0
ansible.netcommon 1.5.0
ansible.posix 1.4.0
community.aws 4.2.0
community.crypto 2.7.0
community.docker 3.1.0
community.general 5.6.0
community.mysql 3.5.1
Configuration
$ ansible-config dump --only-changed
ANSIBLE_FORCE_COLOR(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = True
CACHE_PLUGIN(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = jsonfile
CACHE_PLUGIN_CONNECTION(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = ~/.ansible/fact_cache
CACHE_PLUGIN_TIMEOUT(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = 86400
CALLBACKS_ENABLED(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = ['ansible.posix.profile_tasks']
DEFAULT_PRIVATE_KEY_FILE(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = /home/bryant/.ssh/ansible-control-node_rsa
DEFAULT_REMOTE_USER(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = ubuntu
DEFAULT_ROLES_PATH(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = ['/home/bryant/.ansible/roles', '/home/bryant/src/api_guys/ansible-deploy-vst/roles']
DEFAULT_STDOUT_CALLBACK(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = debug
DEFAULT_TIMEOUT(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = 10
DEFAULT_VAULT_IDENTITY(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = prod
DEFAULT_VAULT_PASSWORD_FILE(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = /home/bryant/src/api_guys/ansible-deploy-vst/vault_pass_from_env.sh
HOST_KEY_CHECKING(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = False
TRANSFORM_INVALID_GROUP_CHARS(/home/bryant/src/api_guys/ansible-deploy-vst/config/machines/localhost_owsus_aws.ansible.cfg) = always
OS / Environment
Ubuntu 22.05, PopOS
Additional Information
Perhaps I shouldn't have to enter all the above versioning info for reporting an ansible UI/UX issue.
Documentation for v 3.5.0 for ansible 6 doesn't fit in Brave browser, horizontally
The same is true for community.aws:
Code of Conduct
- [X] I agree to follow the Ansible Code of Conduct
Files identified in the description: None
If these files are inaccurate, please update the component name section of the description or use the !component bot command.
@life5ign Thanks for taking the time to open this issue.
We don't manage the templates used for generating that documentation it's managed by the Ansible Documentation Working Group. @felixfontein or @samccann Would you be able to move this issue over to the correct repo?
Link to the documentation: https://docs.ansible.com/ansible/devel/collections/amazon/aws/ec2_instance_module.html
Works totally fine with Firefox, but Chromium somehow makes the table too wide. I'll try to figure out what's the problem is...
About moving the issue: the correct repo (https://github.com/ansible-community/antsibull-docs) is in another GH organization, so moving is rather non-trivial. (Basically we need to create a new repository in this GH org, move the issue there, move that repo to the other GH org, move the issue to the correct repo, and then delete that repo. Sounds like too much work :) )
Interestingly, with the latest versions of the sphinx_rtd_theme and sphinx_ansible_theme, this does not happen. (Edit: maybe it's also Sphinx itself, I'm using 5.2.0.post0.)
https://github.com/ansible-community/antsibull-docs/pull/54 improves the CSS by making the left column less wide, but at least for me (when applying these CSS changes directly to the devel docsite with the browser's Inspector) it doesn't resolve the problem completely. I guess upgrading the themes and/or sphinx is needed for that.
Thanks all! I filed the issue here because it doesn't seem to be happening for other collections--sorry for the difficulty.
https://docs.ansible.com/ansible/latest/collections/ansible/posix/synchronize_module.html https://docs.ansible.com/ansible/latest/collections/community/general/apache2_mod_proxy_module.html#ansible-collections-community-general-apache2-mod-proxy-module
These display fine on Brave on my system; let me know if you need more info.
I figured out also the remaining problem: links in tables do not break (but only with Chromium, Firefox automatically breaks them). This is fixed by https://github.com/readthedocs/sphinx_rtd_theme/pull/1193, which is included in version 1.0.0 of the theme. Interestingly, test/sanity/code-smell/docs-build.requirements.txt in ansible-core does include 1.0.0 of that theme, but maybe the actual docs build (jenkins) isn't? @samccann that's something you could check; sphinx-ansible-theme extends sphinx-rtd-theme and thus needs a new version of that one as well.
antsibull-docs 1.7.0 combined with sphinx_rtd_theme 1.0.0 fixes this. (The latter is enough, but then the left column is still very wide compared to the right one.)
Thanks all! I filed the issue here because it doesn't seem to be happening for other collections--sorry for the difficulty.
Yeah, we've got a lot of aliases on the session token parameter (because Amazon renamed things) and that's triggered the issue in the theme.
Thanks for taking the time to open this issue.
I believe this issue's been fixed upstream. Although we have deprecated some of the aliases, there's little more we can do in the collection so I'm going to close this Issue.