From 57a8eca3af8c5ea2205bdfd88952630cf61879a7 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Mon, 6 May 2024 14:52:50 -0700 Subject: pymarkdown: update docs (#83150) Signed-off-by: Abhijeet Kasurde --- .github/CONTRIBUTING.md | 15 ++++++++++----- hacking/backport/README.md | 2 +- hacking/ticket_stubs/bug_internal_api.md | 4 ++-- hacking/ticket_stubs/bug_wrong_repo.md | 22 +++++++++++----------- hacking/ticket_stubs/collections.md | 7 ++++--- ..._newbie_about_gh_and_contributing_to_ansible.md | 6 +++--- hacking/ticket_stubs/no_thanks.md | 5 +++-- hacking/ticket_stubs/pr_duplicate.md | 2 +- hacking/ticket_stubs/pr_merged.md | 4 ++-- hacking/ticket_stubs/proposal.md | 6 +++--- hacking/ticket_stubs/question_not_bug.md | 4 ++-- hacking/ticket_stubs/resolved.md | 2 +- hacking/ticket_stubs/wider_discussion.md | 4 ++-- lib/ansible/galaxy/data/apb/README.md | 10 +++++++--- .../targets/ansible-vault/invalid_format/README.md | 2 +- test/sanity/ignore.txt | 18 ------------------ test/support/README.md | 2 +- 17 files changed, 54 insertions(+), 61 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 35b4523e01..300cff3832 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,9 +4,11 @@ Hi! Nice to see you here! ## QUESTIONS ? -Please see the [Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) for information on how to ask questions on the [mailing lists](https://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information) and IRC. +Please see the [Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) for information on +how to ask questions on the [mailing lists](https://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information) and IRC. -The GitHub issue tracker is not the best place for questions for various reasons, but both IRC and the mailing list are very helpful places for those things, as the community page explains best. +The GitHub issue tracker is not the best place for questions for various reasons, +but both IRC and the mailing list are very helpful places for those things, as the community page explains best. ## CONTRIBUTING ? @@ -14,15 +16,18 @@ By contributing to this project you agree to the [Developer Certificate of Origi The Ansible project is licensed under the [GPL-3.0](COPYING) or later. Some portions of the code fall under other licenses as noted in individual files. -The Ansible project accepts contributions through GitHub pull requests. Please review the [Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) for more information on contributing to Ansible. +The Ansible project accepts contributions through GitHub pull requests. +Please review the [Community Guide](https://docs.ansible.com/ansible/latest/community/index.html) for more information on contributing to Ansible. ## BUG TO REPORT ? First and foremost, also check the [Community Guide](https://docs.ansible.com/ansible/latest/community/index.html). -You can report bugs or make enhancement requests at the [Ansible GitHub issue page](http://github.com/ansible/ansible/issues/new/choose) by filling out the issue template that will be presented. +You can report bugs or make enhancement requests at +the [Ansible GitHub issue page](http://github.com/ansible/ansible/issues/new/choose) by filling out the issue template that will be presented. -Also please make sure you are testing on the latest released version of Ansible or the development branch; see the [Installation Guide](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) for details. +Also please make sure you are testing on the latest released version of Ansible or the development branch. +See the [Installation Guide](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html) for details. Thanks! diff --git a/hacking/backport/README.md b/hacking/backport/README.md index 3fb212b33e..ce7112b22f 100644 --- a/hacking/backport/README.md +++ b/hacking/backport/README.md @@ -4,7 +4,7 @@ This directory contains scripts useful for dealing with and maintaining backports. Scripts in it depend on pygithub, and expect a valid environment variable called `GITHUB_TOKEN`. -To generate a Github token, go to https://github.com/settings/tokens/new +To generate a Github token, go to ## `backport_of_line_adder.py` diff --git a/hacking/ticket_stubs/bug_internal_api.md b/hacking/ticket_stubs/bug_internal_api.md index 76a3bb085c..89162558ca 100644 --- a/hacking/ticket_stubs/bug_internal_api.md +++ b/hacking/ticket_stubs/bug_internal_api.md @@ -13,11 +13,11 @@ but this does not seem to match that case. If you really need a stable API target to use Ansible, consider using ansible-runner: -* https://github.com/ansible/ansible-runner +* Because this project is very active, we're unlikely to see comments made on closed tickets and we lock them after some time. If you or anyone else has any further questions, please let us know by using any of the communication methods listed in the page below: -* https://docs.ansible.com/ansible/latest/community/communication.html +* Thank you once again for this and your interest in Ansible! diff --git a/hacking/ticket_stubs/bug_wrong_repo.md b/hacking/ticket_stubs/bug_wrong_repo.md index b711e85f3a..704ab5ed54 100644 --- a/hacking/ticket_stubs/bug_wrong_repo.md +++ b/hacking/ticket_stubs/bug_wrong_repo.md @@ -8,22 +8,22 @@ This appears to be something that should be filed against another project or bug << CHOOSE AS APPROPRIATE >> -* https://github.com/ansible-community/ansible-lint -* https://github.com/ansible/ansible-runner -* https://github.com/ansible/ansible-navigator -* https://github.com/ansible-community/antsibull -* https://github.com/ansible-community/ara -* https://github.com/ansible/awx -* https://github.com/ansible-collections/community.general -* https://github.com/ansible-community/molecule -* For AAP or Tower licensees report issues via your Red Hat representative or https://issues.redhat.com +* +* +* +* +* +* +* +* +* For AAP or Tower licensees report issues via your Red Hat representative or If you can stop by the tracker or forum for one of those projects, we'd appreciate it. Because this project is very active, we're unlikely to see comments made on closed tickets and we lock them after some time. Should you still wish to discuss things further, or if you disagree with our thought process, please stop by one of our two mailing lists: -* https://groups.google.com/forum/#!forum/ansible-devel +* * Matrix: [#devel:ansible.im](https://matrix.to/#/#devel:ansible.im) * IRC: #ansible-devel on [irc.libera.chat](https://libera.chat/) @@ -31,6 +31,6 @@ We'd be happy to discuss things. See this page for a complete list of communication channels and their purposes: -* https://docs.ansible.com/ansible/latest/community/communication.html +* Thank you once again! diff --git a/hacking/ticket_stubs/collections.md b/hacking/ticket_stubs/collections.md index eecd8151f1..3698ea14bd 100644 --- a/hacking/ticket_stubs/collections.md +++ b/hacking/ticket_stubs/collections.md @@ -2,15 +2,16 @@ Hi! Thank you very much for your submission to Ansible. It means a lot to us that you've taken the time to contribute. -Since Ansible 2.10 we are no longer accepting new modules/plugins into Ansible core. However, we recommend looking into providing this functionality through Ansible Galaxy via Ansible Collections. You can find more information about collections at: +Since Ansible 2.10 we are no longer accepting new modules/plugins into Ansible core. +However, we recommend looking into providing this functionality through Ansible Galaxy via Ansible Collections. You can find more information about collections at: -* https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html. +* . Because this project is very active, we're unlikely to see comments made on closed tickets and we lock them after some time. The mailing list and irc are great ways to ask questions, or post if you don't think this particular issue is resolved. See this page for a complete and up to date list of communication channels and their purposes: -* https://docs.ansible.com/ansible/latest/community/communication.html +* Thank you once again for this and your interest in Ansible! diff --git a/hacking/ticket_stubs/guide_newbie_about_gh_and_contributing_to_ansible.md b/hacking/ticket_stubs/guide_newbie_about_gh_and_contributing_to_ansible.md index 3f4de70d1f..708eedc53d 100644 --- a/hacking/ticket_stubs/guide_newbie_about_gh_and_contributing_to_ansible.md +++ b/hacking/ticket_stubs/guide_newbie_about_gh_and_contributing_to_ansible.md @@ -9,13 +9,13 @@ Assuming that you wanted to create actual contribution, I think that you may want to learn and read through the following articles I've gathered for you: -• https://opensource.guide/how-to-contribute/ -• https://docs.ansible.com/ansible/devel/community/ +• +• Because this project is very active, we're unlikely to see comments made on closed tickets and we lock them after some time. If you or anyone else has any further questions, please let us know by using any of the communication methods listed in the page below: - https://docs.ansible.com/ansible/latest/community/communication.html + Have a nice day! diff --git a/hacking/ticket_stubs/no_thanks.md b/hacking/ticket_stubs/no_thanks.md index 2e2143fe61..8c32b6bc4f 100644 --- a/hacking/ticket_stubs/no_thanks.md +++ b/hacking/ticket_stubs/no_thanks.md @@ -11,8 +11,9 @@ However, we're absolutely always up for discussion. Because this project is very active, we're unlikely to see comments made on closed tickets and we lock them after some time. If you or anyone else has any further questions, please let us know by using any of the communication methods listed in the page below: -* https://docs.ansible.com/ansible/latest/community/communication.html +* -In the future, sometimes starting a discussion on the development list prior to implementing a feature can make getting things included a little easier, but it's not always necessary. +In the future, sometimes starting a discussion on the development list prior to implementing +a feature can make getting things included a little easier, but it's not always necessary. Thank you once again for this and your interest in Ansible! diff --git a/hacking/ticket_stubs/pr_duplicate.md b/hacking/ticket_stubs/pr_duplicate.md index 01a2a72809..080e4e4abf 100644 --- a/hacking/ticket_stubs/pr_duplicate.md +++ b/hacking/ticket_stubs/pr_duplicate.md @@ -15,6 +15,6 @@ In the future, sometimes starting a discussion on the development list prior to Because this project is very active, we're unlikely to see comments made on closed tickets and we lock them after some time. If you or anyone else has any further questions, please let us know by using any of the communication methods listed in the page below: -* https://docs.ansible.com/ansible/latest/community/communication.html +* Thank you once again for this and your interest in Ansible! diff --git a/hacking/ticket_stubs/pr_merged.md b/hacking/ticket_stubs/pr_merged.md index 0183ee9063..5d354e3586 100644 --- a/hacking/ticket_stubs/pr_merged.md +++ b/hacking/ticket_stubs/pr_merged.md @@ -1,7 +1,7 @@ Hi! This has been merged in, and will also be included in the next major release. -For more info on our process see https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html#ansible-core-workflow +For more info on our process see If you or anyone else has any further questions, please let us know by stopping by one of the mailing lists or chat channels, as appropriate. @@ -10,6 +10,6 @@ The mailing list and irc are great ways to ask questions, or post if you don't t See this page for a complete and up to date list of communication channels and their purposes: -* https://docs.ansible.com/ansible/latest/community/communication.html +* Thank you! diff --git a/hacking/ticket_stubs/proposal.md b/hacking/ticket_stubs/proposal.md index 25d4cb403f..4b672856f3 100644 --- a/hacking/ticket_stubs/proposal.md +++ b/hacking/ticket_stubs/proposal.md @@ -3,16 +3,16 @@ Hi! Ansible has a Proposal process for large feature ideas or changes in current design and functionality, such as this. If you are still interested in seeing this new feature get into Ansible, please submit a proposal for it using this process. -https://github.com/ansible/proposals/blob/master/proposals_process_proposal.md + Because this project is very active, we're unlikely to see comments made on closed tickets and we lock them after some time. The mailing list and irc are great ways to ask questions, or post if you don't think this particular issue is resolved. * #ansible-devel on [irc.libera.chat](https://libera.chat/) -* https://groups.google.com/forum/#!forum/ansible-devel +* Or check this page for a more complete list of communication channels and their purposes: -* https://docs.ansible.com/ansible/latest/community/communication.html +* Thank you! diff --git a/hacking/ticket_stubs/question_not_bug.md b/hacking/ticket_stubs/question_not_bug.md index f4b143fbb6..b53b367464 100644 --- a/hacking/ticket_stubs/question_not_bug.md +++ b/hacking/ticket_stubs/question_not_bug.md @@ -5,11 +5,11 @@ Thanks very much for your interest in Ansible. It means a lot to us. This appears to be a user question, and we'd like to direct these kinds of things to either the mailing list or the IRC channel. * IRC: #ansible on [irc.libera.chat](https://libera.chat/) -* mailing list: https://groups.google.com/forum/#!forum/ansible-project +* mailing list: See this page for a complete and up to date list of communication channels and their purposes: -* https://docs.ansible.com/ansible/latest/community/communication.html +* Because this project is very active, we're unlikely to see comments made on closed tickets and we lock them after some time. If don't you think this particular issue is resolved, you should still stop by there first, we'd appreciate it. diff --git a/hacking/ticket_stubs/resolved.md b/hacking/ticket_stubs/resolved.md index 8eedbcfc15..f040d6d05a 100644 --- a/hacking/ticket_stubs/resolved.md +++ b/hacking/ticket_stubs/resolved.md @@ -11,6 +11,6 @@ The mailing list and irc are great ways to ask questions, or post if you don't t See this page for a complete list of communication channels and their purposes: -* https://docs.ansible.com/ansible/latest/community/communication.html +* Thank you! diff --git a/hacking/ticket_stubs/wider_discussion.md b/hacking/ticket_stubs/wider_discussion.md index 74585816fc..e8b13b3492 100644 --- a/hacking/ticket_stubs/wider_discussion.md +++ b/hacking/ticket_stubs/wider_discussion.md @@ -10,12 +10,12 @@ Reasons for this include: Because this project is very active, we're unlikely to see comments made on closed tickets and we lock them after some time. Can you please post on ansible-development list so we can talk about this idea with the wider group? -* https://groups.google.com/forum/#!forum/ansible-devel +* * Matrix: [#devel:ansible.im](https://matrix.to/#/#devel:ansible.im) * #ansible-devel on [irc.libera.chat](https://libera.chat/) For other alternatives, check this page for a more complete list of communication channels and their purposes: -* https://docs.ansible.com/ansible/latest/community/communication.html +* Thank you once again for this and your interest in Ansible! diff --git a/lib/ansible/galaxy/data/apb/README.md b/lib/ansible/galaxy/data/apb/README.md index 2e350a03fd..0f51845fbd 100644 --- a/lib/ansible/galaxy/data/apb/README.md +++ b/lib/ansible/galaxy/data/apb/README.md @@ -6,17 +6,21 @@ A brief description of the APB goes here. Requirements ------------ -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. +For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. APB Variables -------------- -A description of the settable variables for this APB should go here, including any variables that are in defaults/main.yml, vars/main.yml, apb.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (i.e. hostvars, group vars, etc.) should be mentioned here as well. +A description of the settable variables for this APB should go here, including any variables that are in defaults/main.yml, vars/main.yml, apb.yml, and +any variables that can/should be set via parameters to the role. +Any variables that are read from other roles and/or the global scope (i.e. hostvars, group vars, etc.) should be mentioned here as well. Dependencies ------------ -A list of other APBs/roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +A list of other APBs/roles hosted on Galaxy should go here, plus any details in regards to +parameters that may need to be set for other roles, or variables that are used from other roles. Example Playbook ---------------- diff --git a/test/integration/targets/ansible-vault/invalid_format/README.md b/test/integration/targets/ansible-vault/invalid_format/README.md index cbbc07a965..850dc8f948 100644 --- a/test/integration/targets/ansible-vault/invalid_format/README.md +++ b/test/integration/targets/ansible-vault/invalid_format/README.md @@ -1 +1 @@ -Based on https://github.com/yves-vogl/ansible-inline-vault-issue +Based on diff --git a/test/sanity/ignore.txt b/test/sanity/ignore.txt index a4cfe5c574..9f6b7ed438 100644 --- a/test/sanity/ignore.txt +++ b/test/sanity/ignore.txt @@ -167,28 +167,10 @@ test/units/utils/collection_loader/fixtures/collections_masked/ansible_collectio test/units/utils/collection_loader/fixtures/collections_masked/ansible_collections/testns/testcoll/__init__.py empty-init # testing that collections don't need inits test/units/utils/collection_loader/test_collection_loader.py pylint:undefined-variable # magic runtime local var splatting test/units/utils/collection_loader/fixtures/collections/ansible_collections/testns/testcoll/plugins/module_utils/my_util.py boilerplate # test requires missing boilerplate -.github/CONTRIBUTING.md pymarkdown:line-length -hacking/backport/README.md pymarkdown:no-bare-urls -hacking/ticket_stubs/bug_internal_api.md pymarkdown:no-bare-urls -hacking/ticket_stubs/bug_wrong_repo.md pymarkdown:no-bare-urls -hacking/ticket_stubs/collections.md pymarkdown:line-length -hacking/ticket_stubs/collections.md pymarkdown:no-bare-urls -hacking/ticket_stubs/guide_newbie_about_gh_and_contributing_to_ansible.md pymarkdown:no-bare-urls -hacking/ticket_stubs/no_thanks.md pymarkdown:line-length -hacking/ticket_stubs/no_thanks.md pymarkdown:no-bare-urls -hacking/ticket_stubs/pr_duplicate.md pymarkdown:no-bare-urls -hacking/ticket_stubs/pr_merged.md pymarkdown:no-bare-urls -hacking/ticket_stubs/proposal.md pymarkdown:no-bare-urls -hacking/ticket_stubs/question_not_bug.md pymarkdown:no-bare-urls -hacking/ticket_stubs/resolved.md pymarkdown:no-bare-urls -hacking/ticket_stubs/wider_discussion.md pymarkdown:no-bare-urls -lib/ansible/galaxy/data/apb/README.md pymarkdown:line-length lib/ansible/galaxy/data/container/README.md pymarkdown:line-length lib/ansible/galaxy/data/default/role/README.md pymarkdown:line-length lib/ansible/galaxy/data/network/README.md pymarkdown:line-length README.md pymarkdown:line-length -test/integration/targets/ansible-vault/invalid_format/README.md pymarkdown:no-bare-urls -test/support/README.md pymarkdown:no-bare-urls test/units/cli/test_data/role_skeleton/README.md pymarkdown:line-length test/integration/targets/find/files/hello_world.gbk no-smart-quotes test/integration/targets/find/files/hello_world.gbk no-unwanted-characters diff --git a/test/support/README.md b/test/support/README.md index d5244823d1..1aa4428fa7 100644 --- a/test/support/README.md +++ b/test/support/README.md @@ -8,4 +8,4 @@ In almost every case, pull requests affecting files under this directory will be closed. **You are likely looking for something under -https://github.com/ansible-collections/ instead.** + instead.** -- cgit v1.2.3