community.general icon indicating copy to clipboard operation
community.general copied to clipboard

Feature. Add chapter 'Lists of dictionaries' to docsite

Open vbotka opened this issue 1 year ago • 9 comments

SUMMARY

Add filter_guide -> abstract_informations -> lists_of_dictionaries:

  • keep_keys
  • remove_keys
  • replace_keys
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

filter_guide-abstract_informations-lists_of_dictionaries.rst filter_guide-abstract_informations-lists_of_dictionaries-remove_keys.rst filter_guide-abstract_informations-lists_of_dictionaries-replace_keys.rst filter_guide-abstract_informations-lists_of_dictionaries-keep_keys.rst

ADDITIONAL INFORMATION

Created helpers:

  • docs/docsite/helper/keep_keys
  • docs/docsite/helper/remove_keys
  • docs/docsite/helper/replace_keys

Create RST files by running the below command in the helper/*_keys directory

shell> ansible-playbook playbook.yml

vbotka avatar Jun 10 '24 15:06 vbotka

@vbotka This PR was evaluated as a potentially problematic PR for the following reasons:

  • More than 50 changed files.

Such PR can only be merged by human. Contact a Core team member to review this PR on IRC: #ansible-devel on Libera.chat IRC

click here for bot help

ansibullbot avatar Jun 10 '24 15:06 ansibullbot

For the record: There seems to be a problem with needs_rebase

shell> git pull --rebase upstream main
From https://github.com/ansible-collections/community.general
 * branch                main       -> FETCH_HEAD
The current branch feature-docsite-keep_keys is up to date.
shell> git push --force-with-lease
Everything up-to-date

vbotka avatar Jun 10 '24 15:06 vbotka

I think needs_rebase is added because of More than 50 changed files.; usually that number of changed files implies that someone screwed up a rebase and added some random unrelated commits. In this case it's safe to ignore :-)

felixfontein avatar Jun 10 '24 18:06 felixfontein

... it's safe to ignore :-)

Thank you for the comment!

vbotka avatar Jun 11 '24 12:06 vbotka

@vbotka this now has a conflict.

felixfontein avatar Jun 13 '24 05:06 felixfontein

... now has a conflict.

This file shouldn't be included in the PR. I rebased the PR and resolved the conflict. Sorry for the noise. I tested all helpers and docsite. This PR should be ready. Thank you!

vbotka avatar Jun 13 '24 10:06 vbotka

The test licenses failed with 12 errors:

docs/docsite/helper/keep_keys/tests.yml.sha1:0:0: found no copyright notice
docs/docsite/helper/keep_keys/tests.yml.sha1:0:0: must have at least one license
docs/docsite/helper/keep_keys/keep_keys.rst.sha1:0:0: found no copyright notice
docs/docsite/helper/keep_keys/keep_keys.rst.sha1:0:0: must have at least one license
docs/docsite/helper/remove_keys/remove_keys.rst.sha1:0:0: found no copyright notice
docs/docsite/helper/remove_keys/remove_keys.rst.sha1:0:0: must have at least one license
docs/docsite/helper/remove_keys/tests.yml.sha1:0:0: found no copyright notice
docs/docsite/helper/remove_keys/tests.yml.sha1:0:0: must have at least one license
docs/docsite/helper/replace_keys/tests.yml.sha1:0:0: found no copyright notice
docs/docsite/helper/replace_keys/tests.yml.sha1:0:0: must have at least one license
docs/docsite/helper/replace_keys/replace_keys.rst.sha1:0:0: found no copyright notice
docs/docsite/helper/replace_keys/replace_keys.rst.sha1:0:0: must have at least one license

click here for bot help

ansibullbot avatar Jun 28 '24 08:06 ansibullbot

For files that do not support comments, you can add a .license file. See tests/sanity/ignore-*.txt.license for examples.

felixfontein avatar Jun 28 '24 20:06 felixfontein

For files that do not support comments, you can add a .license file. See tests/sanity/ignore-*.txt.license for examples.

Thank you! I used this and simplified templates.

vbotka avatar Jun 28 '24 22:06 vbotka

Backport to stable-9: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-9/caecb2297fbf8cfb9ae80926ead10b4fb11a003f/pr-8482

Backported as https://github.com/ansible-collections/community.general/pull/8582

🤖 @patchback I'm built with octomachinery and my source is open — https://github.com/sanitizers/patchback-github-app.

patchback[bot] avatar Jul 05 '24 06:07 patchback[bot]

@vbotka thanks for your contribution!

felixfontein avatar Jul 05 '24 06:07 felixfontein

@vbotka thanks for your contribution!

@felixfontein thank you!

vbotka avatar Jul 08 '24 05:07 vbotka