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

[DOCS] Document vCenter ESXi proxy options. Cleanup headers of all VMware proxies. Fixes #61987 #61990

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

ggiesen
Copy link
Contributor

@ggiesen ggiesen commented Apr 27, 2022

What does this PR do?

Documents vCenter options for ESXi proxy. Spelling, formatting and consistency cleanups of all VMware proxy docs.

What issues does this PR fix or reference?

Fixes: #61987

Merge requirements satisfied?

[NOTICE] Bug fixes or features added to Salt require tests.

  • Docs

Commits signed with GPG?

No

Please review Salt's Contributing Guide for best practices.

See GitHub's page on GPG signing for more information about signing commits with GPG.

@ggiesen ggiesen requested a review from a team as a code owner April 27, 2022 01:03
@ggiesen ggiesen requested review from garethgreenaway and removed request for a team April 27, 2022 01:03
@ggiesen ggiesen changed the title Document vCenter ESXi proxy options. Cleanup headers of all VMware proxies. Fixes #61987 [DOCS] Document vCenter ESXi proxy options. Cleanup headers of all VMware proxies. Fixes #61987 Apr 27, 2022
@ggiesen ggiesen added the Documentation Relates to Salt documentation label Apr 27, 2022
@github-actions
Copy link

Hi! I'm your friendly PR bot!

You might be wondering what I'm doing commenting here on your PR.

Yes, as a matter of fact, I am...

I'm just here to help us improve the documentation. I can't respond to
questions or anything, but what I can do, I do well!

Okay... so what do you do?

I detect modules that are missing docstrings or "CLI Example" on existing docstrings!
When I was created we had a lot of these. The documentation for these
modules need some love and attention to make Salt better for our users.

So what does that have to do with my PR?

I noticed that in this PR there are some files changed that have some of these
issues. So I'm leaving this comment to let you know your options.

Okay, what are they?

Well, my favorite, is that since you were making changes here I'm hoping that
you would be the most familiar with this module and be able to add some other
examples or fix any of the reported issues.

If I can, then what?

Well, you can either add them to this PR or add them to another PR. Either way is fine!

Well... what if I can't, or don't want to?

That's also fine! We appreciate all contributions to the Salt Project. If you
can't add those other examples, either because you're too busy, or unfamiliar,
or you just aren't interested, we still appreciate the contributions that
you've made already.

Whatever approach you decide to take, just drop a comment here letting us know!

Detected Issues (click me)
Check Known Missing Docstrings...........................................Failed
- hook id: invoke
- duration: 1.05s
- exit code: 1

/home/runner/.cache/pre-commit/repowbk5o90m/py_env-python3/lib/python3.9/site-packages/_distutils_hack/init.py:30: UserWarning: Setuptools is replacing distutils.
warnings.warn("Setuptools is replacing distutils.")
The function 'is_connected_via_vcenter' on 'salt/proxy/esxi.py' does not have a docstring
Found 1 errors


Thanks again!

@barbaricyawps barbaricyawps self-requested a review February 6, 2023 17:12
Copy link
Contributor

@barbaricyawps barbaricyawps left a comment

Choose a reason for hiding this comment

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

@ggiesen , sorry that it's taken me awhile to look at this. I've approved this PR. Just be aware we'll need to rebase this because I've added some warnings to this module that users should use the VMware Salt extension instead.

@barbaricyawps barbaricyawps self-requested a review February 6, 2023 17:15
Copy link
Contributor

@barbaricyawps barbaricyawps left a comment

Choose a reason for hiding this comment

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

Actually, I had to revoke my approval because it looks like we're getting a missing docstring warning on this?

@ggiesen, what's your take on the missing docstring error flagged by the GitHub actions bot?

@barbaricyawps barbaricyawps added the pending-changes The pull request needs additional changes before it can be merged label Feb 13, 2023
@barbaricyawps
Copy link
Contributor

@ggiesen , any updates on this PR?

@dwoz
Copy link
Contributor

dwoz commented Dec 16, 2023

Pre-commit failing.

@dwoz dwoz added this to the Argon v3008.0 milestone Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to Salt documentation pending-changes The pull request needs additional changes before it can be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] ESXi proxy minion docs missing authentication options
3 participants