generated from ansible-collections/collection_template
-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[stable-2] Backport of all the doc PRs merged to main since the last …
…backporting (#182) * Add CONTRIBUTORS file (#166) (cherry picked from commit ac927fd) * Add documentation for privs with functions and procedures (#169) (cherry picked from commit 6bce48e) * Update README.md (#168) * Update README.md * Fix * Add MAINTAINERS file (cherry picked from commit 479edd8) * Improve wording in README (#170) * Improve wording in README * Update README.md Co-authored-by: Jorge Rodriguez (A.K.A. Tiriel) <[email protected]> Co-authored-by: Jorge Rodriguez (A.K.A. Tiriel) <[email protected]> (cherry picked from commit c909aa2) * Update REVIEW_CHECKLIST.md (#171) (cherry picked from commit 2236110) * README: add a note how people can complain (#172) * README: add a note how people can complain * Change * Improve * Update README.md Co-authored-by: Jorge Rodriguez (A.K.A. Tiriel) <[email protected]> Co-authored-by: Jorge Rodriguez (A.K.A. Tiriel) <[email protected]> (cherry picked from commit be4e84a) * README: fix typos (#174) (cherry picked from commit 2a80c30) * README.md: Add link to IRC (#175) (cherry picked from commit 3335a95) * README.md, CONTRIBUTING.md: add links to the Maintainer guidelines (#179) (cherry picked from commit 8fad3f8) * Update README (#181) (cherry picked from commit 6d9288d) Co-authored-by: Alexander Skiba <[email protected]>
- Loading branch information
1 parent
a68c83f
commit 2e748ef
Showing
6 changed files
with
317 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,273 @@ | ||
| 116davinder | ||
| 20 | ||
| 28 | ||
| 29 | ||
| 4 | ||
| 4n70w4 | ||
| abadger | ||
| abondis | ||
| acozine | ||
| adamchainz | ||
| adq | ||
| Akasurde | ||
| Alexander198961 | ||
| alustenberg | ||
| aminvakil | ||
| amitk79 | ||
| amree | ||
| Andersson007 | ||
| andrewhowdencom | ||
| ansibot | ||
| anthonyxpalermo | ||
| antonioribeiro | ||
| apollo13 | ||
| aquach | ||
| arcmop | ||
| asad-at-srt | ||
| AshDevilRed | ||
| aurimasl | ||
| axelll | ||
| axisK | ||
| azielke | ||
| baldpale | ||
| banyek | ||
| BarbzYHOOL | ||
| Berbe | ||
| bjne | ||
| bmalynovytch | ||
| bmildren | ||
| boreal321 | ||
| brutus | ||
| burner1024 | ||
| calfonso | ||
| candeira | ||
| caphrim007 | ||
| cdalbergue | ||
| checkphi | ||
| chrismeyersfsu | ||
| ChristopherGAndrews | ||
| cmodijk | ||
| codeaken | ||
| codebymikey | ||
| coreylane | ||
| CormacBracken | ||
| cosmix | ||
| cptMikky | ||
| crashes | ||
| dagwieers | ||
| damianmoore | ||
| Davidffry | ||
| denisemauldin | ||
| diclophis | ||
| d-lee | ||
| dmp1ce | ||
| dnelson | ||
| dramaley | ||
| drybjed | ||
| drzraf | ||
| DSpeichert | ||
| dungdm93 | ||
| dwagelaar | ||
| dylanjbarth | ||
| einarc | ||
| E-M | ||
| eowin | ||
| Ernest0x | ||
| esamattis | ||
| Everspace | ||
| F21 | ||
| faitno | ||
| felixfontein | ||
| flatrocks | ||
| fourjay | ||
| fraff | ||
| g00fy- | ||
| geerlingguy | ||
| georgeOsdDev | ||
| ghjm | ||
| ghost | ||
| giacmir | ||
| giorgio-v | ||
| gkoller | ||
| gottwald | ||
| gstorme | ||
| gundalow | ||
| hansbaer | ||
| hchargois | ||
| hluaces | ||
| hwali | ||
| hyperfocus1338 | ||
| igormukhingmailcom | ||
| imjoseangel | ||
| infigoKriti | ||
| ipergenitsa | ||
| iredmail | ||
| ivandigiusto | ||
| jadbaz | ||
| jaikdean | ||
| jamescassell | ||
| janosmiko | ||
| jarnold-timeout | ||
| JaSafieddine | ||
| jborean93 | ||
| jctanner | ||
| jean-christophe-manciot | ||
| Jean-Daniel | ||
| jgornick | ||
| jhagg | ||
| jhoekx | ||
| jirib | ||
| jkleckner | ||
| jkordish | ||
| jlaska | ||
| Jmainguy | ||
| jochu | ||
| JoelFeiner | ||
| johnavp1989 | ||
| jonatasbaldin | ||
| Jorge-Rodriguez | ||
| jpjaatin | ||
| jpmens | ||
| JSafieddine | ||
| jsmartin | ||
| juergenhoetzel | ||
| jw34 | ||
| kalaisubbiah | ||
| kenichi-ogawa-1988 | ||
| kkeane | ||
| klingac | ||
| kotso | ||
| kuntalFreshBooks | ||
| kurtdavis | ||
| larsks | ||
| ldesgrange | ||
| leeadh | ||
| LeonB | ||
| leucos | ||
| loomsen | ||
| lorin | ||
| lowwalker | ||
| lperezs | ||
| makmanalp | ||
| manuelmorena | ||
| MarcinOrlowski | ||
| markdorison | ||
| markotitel | ||
| marktheunissen | ||
| markuman | ||
| mattclay | ||
| matt-horwood-mayden | ||
| mavimo | ||
| maxamillion | ||
| maxbube | ||
| mcgoldrickm | ||
| meanstrong | ||
| meersjo | ||
| megamisan | ||
| michaeldg | ||
| michalmedvecky | ||
| MikeiLL | ||
| milky-milk | ||
| milosz | ||
| mistaka0s | ||
| mklassen | ||
| mkrizek | ||
| mmoya | ||
| mohag | ||
| mohsenSy | ||
| mpdehaan | ||
| MRwangyd | ||
| mverwijs | ||
| mvgrimes | ||
| mysqlbox | ||
| netmonk | ||
| nhojpatrick | ||
| nicolas-g | ||
| NielsH | ||
| nitinkansal1984 | ||
| nitzmahone | ||
| Ompragash | ||
| on | ||
| order | ||
| organman91 | ||
| p53 | ||
| pakal | ||
| paulbadcock | ||
| pennycoders | ||
| petoju | ||
| petracvv | ||
| pgrenaud | ||
| philfry | ||
| pileofrogs | ||
| pkaramol | ||
| platypus-geek | ||
| plumbeo | ||
| pratikgadiya12 | ||
| pshanbhag | ||
| r0bj | ||
| rajsshah86 | ||
| reduzent | ||
| relrod | ||
| resmo | ||
| ricco24 | ||
| richlv | ||
| riupie | ||
| rndmh3ro | ||
| robertdebock | ||
| robpblake | ||
| rokka-n | ||
| Roxyrob | ||
| roysmith | ||
| rthouvenin | ||
| ruudk | ||
| samccann | ||
| samdoran | ||
| sayap | ||
| scottbrown | ||
| seanorama | ||
| sedrubal | ||
| sergey-trukhin | ||
| Shaps | ||
| shrikeh | ||
| sivel | ||
| skalfyfan | ||
| skoriy88 | ||
| sperantus | ||
| spoyd | ||
| steverweber | ||
| steveteahan | ||
| stijnopheide | ||
| stintel | ||
| stoned | ||
| strixBE | ||
| SWADESNA | ||
| tapologo | ||
| tejatsk14 | ||
| tersmitten | ||
| the | ||
| the02 | ||
| thomasliddledba | ||
| time-palominodb | ||
| timorunge | ||
| Tomasthanes | ||
| tomdymond | ||
| Tronde | ||
| tvlooy | ||
| tyll | ||
| UncertaintyP | ||
| vamshi8 | ||
| vanne | ||
| vdboor | ||
| vmahadev | ||
| v-zhuravlev | ||
| webmat | ||
| wedi | ||
| whysthatso | ||
| willthames | ||
| windowsansiblernew | ||
| wrosario | ||
| xiata | ||
| Xyon | ||
| yangchao0512 | ||
| ziegenberg | ||
| Zverik |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| bmalynovytch | ||
| Jorge-Rodriguez | ||
| Andersson007 (andersson007_ in #ansible-community IRC) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,3 @@ | ||
| # Review Checklist | ||
|
|
||
| When reviewing, keep in mind that we follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our contributions and interactions within this repository. | ||
|
|
||
| If you are a committer, also refer to the [Ansible committer guidelines](https://docs.ansible.com/ansible/devel/community/committer_guidelines.html). | ||
|
|
||
| **General tips** | ||
| - Try to create a culture of collaboration when reviewing | ||
| - Welcome the author and thank them for the pull request | ||
| - When suggesting changes, try to use questions, not statements | ||
| - When suggesting mandatory changes, do it as politely as possible providing documentation references | ||
| - If your suggestion is optional or a matter of personal preferences, please say it explicitly | ||
| - When asking for adding tests or for complex code refactoring, say that the author is welcome to ask for clarifications and help if they need | ||
| - If somebody suggests a good idea, mention it or put a thumbs up | ||
| - After merging, thank the author and reviewers for their time and effort | ||
|
|
||
| **Standards and documentation** | ||
| - [ ] if the pull request is not a documentation fix, it must include a [changelog fragment](https://docs.ansible.com/ansible/devel/community/development_process.html#creating-a-changelog-fragment) - please check the format carefully | ||
| - [ ] if new files are added with the pull request, they follow the [licensing rules](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#licensing) | ||
| - [ ] the changes follow the [Ansible documentation standards](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html) and the [style guide](https://docs.ansible.com/ansible/devel/dev_guide/style_guide/index.html#style-guide) | ||
| - [ ] the changes follow the [development conventions](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html) | ||
| - [ ] if a new plugin is added, it is one of the [allowed plugin types](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#modules-plugins) | ||
| - [ ] documentation, examples, and return sections use FQCNs for the `M(..)` [format macros](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#linking-and-other-format-macros-within-module-documentation) when referring to modules | ||
| - [ ] modules and plugins from ansible-core use `ansible.builtin.` as a FQCN prefix when mentioned | ||
| - [ ] when a new option, module, plugin, or return value is added, the corresponding documentation or return sections use `version_added:` containing the *collection* version which they will be first released in | ||
| * this usually is the next minor release, sometimes the next major release (example: if 2.7.5 is the current release, the next minor release will be 2.8.0, and the next major release will be 3.0.0) | ||
| - [ ] FQCNs are used for `extends_documentation_fragment:`, unless the author is referring to doc_fragments from ansible-core | ||
|
|
||
| **Tests (if applicable and technically possible to implement)** | ||
| - [ ] the pull request has [integration tests](https://docs.ansible.com/ansible/devel/dev_guide/testing_integration.html) | ||
| - [ ] the pull request has [unit tests](https://docs.ansible.com/ansible/devel/dev_guide/testing_units.html) | ||
| - [ ] all changes are covered | ||
| - [ ] integration tests also cover `check_mode` (if it is supported) | ||
| - [ ] integration tests check an actual state of the system, not only what the module reports (for example, if the module changes a file, check that the file was actually changed by using the `ansible.builtin.stat` module) | ||
|
|
||
| **Other** | ||
| - [ ] the pull request does not contain merge commits (see GitHub warnings at the bottom of the pull request) - in this case, ask the author to rebase the pull request branch | ||
| - [ ] if the pull request contains breaking changes, ask the author and the collection maintainers if it is really needed and there is no way not to introduce them | ||
| Refer to the [Collection review checklist](https://github.com/ansible/community-docs/blob/main/review_checklist.rst). |
Oops, something went wrong.