Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Needs SC review] community/other_tools_and_programs.rst: update #2284

Merged
merged 6 commits into from
Dec 18, 2024

Conversation

Andersson007
Copy link
Contributor

community/other_tools_and_programs.rst: update

Based on https://forum.ansible.com/t/should-we-revamp-the-tools-and-programs-page/39024

This PR

  • Generalizes text editors info
  • Leaves only VS code extensions as we're sure they're maintained
  • Refers to awesome ansible for tooling
  • Something doesn't even work like ansible-reviewer, so it removes tools that we're not sure about. Awesome ansible welcomes them

Copy link
Contributor

@gundalow gundalow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's update and merge ansible-awesome before we merge this.

* `Ansible vim <https://github.com/pearofducks/ansible-vim>`_ - vim syntax plugin for Ansible 2.x, it supports YAML playbooks, Jinja2 templates, and Ansible's hosts files.
* `Ansible vim and neovim plugin <https://www.npmjs.com/package/@yaegassy/coc-ansible>`_ - vim plugin (lsp client) for Ansible, it supports autocompletion, syntax highlighting, hover, diagnostics, and goto support.

There are popular open-source editors like Vim or Emacs that support YAML, Jinja, and specifically Ansible through corresponding plugins.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These need adding to https://github.com/ansible-community/awesome-ansible?tab=readme-ov-file#editor-and-ide-integrations (and we should add subheadings for each editor first).

Then we can link to the awesome-ansible

@gundalow gundalow marked this pull request as draft December 11, 2024 11:22
@gundalow gundalow changed the title [Needs SC review] community/other_tools_and_programs.rst: update [Needs SC review] [Depend son awesome ansible update] community/other_tools_and_programs.rst: update Dec 11, 2024
@Andersson007
Copy link
Contributor Author

Andersson007 commented Dec 12, 2024

ansible-community/awesome-ansible#94 <- ready for review

This PR is ready for review again

@Andersson007
Copy link
Contributor Author

The PR moving the stuff has been merged, can we merge this one?

@gundalow gundalow marked this pull request as ready for review December 17, 2024 11:12
Copy link
Contributor

@gundalow gundalow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thank you.

@gundalow gundalow changed the title [Needs SC review] [Depend son awesome ansible update] community/other_tools_and_programs.rst: update [Needs SC review] community/other_tools_and_programs.rst: update Dec 17, 2024
@Andersson007
Copy link
Contributor Author

@samccann , added SC as codeowners, PTAL

@samccann samccann added backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch labels Dec 18, 2024
@samccann samccann merged commit fd41e24 into ansible:devel Dec 18, 2024
11 checks passed
Copy link

patchback bot commented Dec 18, 2024

Backport to stable-2.16: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply fd41e24 on top of patchback/backports/stable-2.16/fd41e247016bb38cb970ee2c6120a8f08ec2813b/pr-2284

Backporting merged PR #2284 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-2.16/fd41e247016bb38cb970ee2c6120a8f08ec2813b/pr-2284 upstream/stable-2.16
  4. Now, cherry-pick PR [Needs SC review] community/other_tools_and_programs.rst: update #2284 contents into that branch:
    $ git cherry-pick -x fd41e247016bb38cb970ee2c6120a8f08ec2813b
    If it'll yell at you with something like fatal: Commit fd41e247016bb38cb970ee2c6120a8f08ec2813b is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x fd41e247016bb38cb970ee2c6120a8f08ec2813b
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR [Needs SC review] community/other_tools_and_programs.rst: update #2284 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.16/fd41e247016bb38cb970ee2c6120a8f08ec2813b/pr-2284
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

Copy link

patchback bot commented Dec 18, 2024

Backport to stable-2.17: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply fd41e24 on top of patchback/backports/stable-2.17/fd41e247016bb38cb970ee2c6120a8f08ec2813b/pr-2284

Backporting merged PR #2284 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-2.17/fd41e247016bb38cb970ee2c6120a8f08ec2813b/pr-2284 upstream/stable-2.17
  4. Now, cherry-pick PR [Needs SC review] community/other_tools_and_programs.rst: update #2284 contents into that branch:
    $ git cherry-pick -x fd41e247016bb38cb970ee2c6120a8f08ec2813b
    If it'll yell at you with something like fatal: Commit fd41e247016bb38cb970ee2c6120a8f08ec2813b is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x fd41e247016bb38cb970ee2c6120a8f08ec2813b
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR [Needs SC review] community/other_tools_and_programs.rst: update #2284 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.17/fd41e247016bb38cb970ee2c6120a8f08ec2813b/pr-2284
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

Copy link

patchback bot commented Dec 18, 2024

Backport to stable-2.18: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply fd41e24 on top of patchback/backports/stable-2.18/fd41e247016bb38cb970ee2c6120a8f08ec2813b/pr-2284

Backporting merged PR #2284 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-2.18/fd41e247016bb38cb970ee2c6120a8f08ec2813b/pr-2284 upstream/stable-2.18
  4. Now, cherry-pick PR [Needs SC review] community/other_tools_and_programs.rst: update #2284 contents into that branch:
    $ git cherry-pick -x fd41e247016bb38cb970ee2c6120a8f08ec2813b
    If it'll yell at you with something like fatal: Commit fd41e247016bb38cb970ee2c6120a8f08ec2813b is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x fd41e247016bb38cb970ee2c6120a8f08ec2813b
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR [Needs SC review] community/other_tools_and_programs.rst: update #2284 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.18/fd41e247016bb38cb970ee2c6120a8f08ec2813b/pr-2284
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

Andersson007 added a commit to Andersson007/ansible-documentation that referenced this pull request Dec 19, 2024
…ible#2284)

* community/other_tools_and_programs.rst: update

* Add a link to Awesome Ansible for editors info

* Fix

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Co-authored-by: Sandra McCann <[email protected]>

* Add SC as codeowners

* Fix

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit fd41e24)
Andersson007 added a commit to Andersson007/ansible-documentation that referenced this pull request Dec 19, 2024
…ible#2284)

* community/other_tools_and_programs.rst: update

* Add a link to Awesome Ansible for editors info

* Fix

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Co-authored-by: Sandra McCann <[email protected]>

* Add SC as codeowners

* Fix

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit fd41e24)
Andersson007 added a commit to Andersson007/ansible-documentation that referenced this pull request Dec 19, 2024
…ible#2284)

* community/other_tools_and_programs.rst: update

* Add a link to Awesome Ansible for editors info

* Fix

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Co-authored-by: Sandra McCann <[email protected]>

* Add SC as codeowners

* Fix

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit fd41e24)
Andersson007 added a commit to Andersson007/ansible-documentation that referenced this pull request Dec 19, 2024
…ible#2284)

* community/other_tools_and_programs.rst: update

* Add a link to Awesome Ansible for editors info

* Fix

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Co-authored-by: Sandra McCann <[email protected]>

* Add SC as codeowners

* Fix

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit fd41e24)
Andersson007 added a commit to Andersson007/ansible-documentation that referenced this pull request Dec 19, 2024
…ible#2284)

* community/other_tools_and_programs.rst: update

* Add a link to Awesome Ansible for editors info

* Fix

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Co-authored-by: Sandra McCann <[email protected]>

* Add SC as codeowners

* Fix

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit fd41e24)
Andersson007 added a commit to Andersson007/ansible-documentation that referenced this pull request Dec 19, 2024
…ible#2284)

* community/other_tools_and_programs.rst: update

* Add a link to Awesome Ansible for editors info

* Fix

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Co-authored-by: Sandra McCann <[email protected]>

* Add SC as codeowners

* Fix

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit fd41e24)
@Andersson007
Copy link
Contributor Author

i've created manual backports, fyi

samccann pushed a commit that referenced this pull request Dec 19, 2024
…) (#2305)

* community/other_tools_and_programs.rst: update

* Add a link to Awesome Ansible for editors info

* Fix

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Co-authored-by: Sandra McCann <[email protected]>

* Add SC as codeowners

* Fix

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit fd41e24)
samccann pushed a commit that referenced this pull request Dec 19, 2024
…) (#2306)

* community/other_tools_and_programs.rst: update

* Add a link to Awesome Ansible for editors info

* Fix

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Co-authored-by: Sandra McCann <[email protected]>

* Add SC as codeowners

* Fix

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit fd41e24)
samccann pushed a commit that referenced this pull request Dec 19, 2024
…) (#2307)

* community/other_tools_and_programs.rst: update

* Add a link to Awesome Ansible for editors info

* Fix

* Update docs/docsite/rst/community/other_tools_and_programs.rst

Co-authored-by: Sandra McCann <[email protected]>

* Add SC as codeowners

* Fix

---------

Co-authored-by: Sandra McCann <[email protected]>
(cherry picked from commit fd41e24)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants