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.

Sign up for GitHub

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

Jump to bottom

updated to describe required parameter #56197

Merged
merged 4 commits into from May 9, 2019
Merged

updated to describe required parameter #56197

merged 4 commits into from May 9, 2019

Conversation

sugitk
Copy link
Contributor

@sugitk sugitk commented May 7, 2019

SUMMARY

according to 'state', described required parameters

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

The customer requested

@sugitk
updated to describe required parameter
4394e2f 
according to 'state', described required parameters
@ansibot
Copy link
Contributor

ansibot commented May 7, 2019

cc @lwade @tgerla
click here for bot help

@ansibot
Copy link
Contributor

ansibot commented May 7, 2019

@sugitk, just so you are aware we have a dedicated Working Group for aws.
You can find other people interested in this in #ansible-aws on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

@ansibot ansibot added affects_2.9 This issue/PR affects Ansible v2.9 aws cloud docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. needs_triage Needs a first human triage before being processed. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels May 7, 2019
@sugitk
Copy link
Contributor Author

sugitk commented May 8, 2019

It seems my modification was wrong with Shippable. Could anyone tell me how to fix those errors?

@acozine
Copy link
Contributor

acozine commented May 8, 2019

@sugitk I think it wants all lines in the description to start with -. Try updating https://github.com/ansible/ansible/pull/56197/files#diff-dea76a894873bd8fbd3173b3a8610a11R199 to look like the other lines and see if that helps.

@acozine acozine removed the needs_triage Needs a first human triage before being processed. label May 8, 2019
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed small_patch needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels May 9, 2019
@acozine
Copy link
Contributor

acozine commented May 9, 2019

Thanks @sugitk for sharing your experience with the entire Ansible community. I added some nitpicky changes to the punctuation and will merge this now.

@acozine acozine merged commit 5346a5c into ansible:devel May 9, 2019
@sugitk
Copy link
Contributor Author

sugitk commented May 10, 2019

@acozine Thank you for your review and merge!

acozine pushed a commit to acozine/ansible that referenced this pull request May 10, 2019
@sugitk @acozine
updated to describe required parameter (ansible#56197)
ec740ea 
* update ec2.py to describe required parameters for each option for `state`

(cherry picked from commit 5346a5c)
@acozine acozine mentioned this pull request May 10, 2019
Merged
acozine added a commit that referenced this pull request May 13, 2019
@acozine
Backport/2.8/docs modules omnibus (#56316)
9b867fb 
* Update gcp_container_cluster_facts.py (#55475) : 'state' is not a supported parameter in this module

(cherry picked from commit 8c7e38a)

* Update win_dns_record.py (#55378): Update examples to show values are strings.

(cherry picked from commit 3fd27f0)

* sensu_subscription very minor docstring typo (#55675)

(cherry picked from commit 2cfaf6e)

* Update win_domain_group_membership.py (#55594): add notes regarding a computer object and fixing a typo

(cherry picked from commit 3f0900f)

* hcloud_server: clarify further for usage of `ssh_keys` (#55713)

(cherry picked from commit 6e9379f)

* Fix template lookup description (#55557): describe that it returns template content with substituted variables.

(cherry picked from commit 9c038b2)

* Update ec2_eip_facts.py (#53040): Add several additional examples showing how to filter on tag, how to filter on the EIP allocation id, and how to set a fact using the output.

(cherry picked from commit 1e2cbef)

* Update ali_instance_facts examples in documentation (#55760) (#55803)

(cherry picked from commit 357daff)

* Update setup.py (#55871): adds a note on privileges needed on BSD systems to use dmidecode

(cherry picked from commit c181e56)

* Remove illegal basic provisioning example (#55892): The bare minimum example in the docs (i.e. only supplying name, state, and cluster) results in the error `state is present but all of the following are missing: task_definition, desired_count`.

(cherry picked from commit c195645)

* clarify docs for rel src state hard (#55972)

(cherry picked from commit 0b00220)

* correct method docs (#55961)

(cherry picked from commit ea57377)

* Update sample (#55654): Correct logConfiguration example on the ecs_taskdefinition module.

(cherry picked from commit 23ddc77)

* add missing exported state do doc string (#56109)

(cherry picked from commit ba9f0d5)

* package_facts: Trivial docs cleanup (#56015): use
the current YAML style and remove unnecessary quotes around `auto`.

Signed-off-by: Major Hayden <major@redhat.com>
(cherry picked from commit 93d24ef)

* Update include_role description (#56001) to discuss tasks: use

(cherry picked from commit 8cb7640)

* Sync required flags from argument_spec to docs (#56121): arguments for certificate, private_key and password were marked as required in the ArgumentSpec, but not in the documentation. 

(cherry picked from commit 6b474a1)

* updated ec2.py to describe required parameters (#56197): for each option for `state`

(cherry picked from commit 5346a5c)

* Update os_image documentation (#49705) to show auth details

(cherry picked from commit f5326aa)
amuraleedhar pushed a commit to amuraleedhar/ansible that referenced this pull request May 21, 2019
@acozine
Backport/2.8/docs modules omnibus (ansible#56316)
a2eee49 
* Update gcp_container_cluster_facts.py (ansible#55475) : 'state' is not a supported parameter in this module

(cherry picked from commit 8c7e38a)

* Update win_dns_record.py (ansible#55378): Update examples to show values are strings.

(cherry picked from commit 3fd27f0)

* sensu_subscription very minor docstring typo (ansible#55675)

(cherry picked from commit 2cfaf6e)

* Update win_domain_group_membership.py (ansible#55594): add notes regarding a computer object and fixing a typo

(cherry picked from commit 3f0900f)

* hcloud_server: clarify further for usage of `ssh_keys` (ansible#55713)

(cherry picked from commit 6e9379f)

* Fix template lookup description (ansible#55557): describe that it returns template content with substituted variables.

(cherry picked from commit 9c038b2)

* Update ec2_eip_facts.py (ansible#53040): Add several additional examples showing how to filter on tag, how to filter on the EIP allocation id, and how to set a fact using the output.

(cherry picked from commit 1e2cbef)

* Update ali_instance_facts examples in documentation (ansible#55760) (ansible#55803)

(cherry picked from commit 357daff)

* Update setup.py (ansible#55871): adds a note on privileges needed on BSD systems to use dmidecode

(cherry picked from commit c181e56)

* Remove illegal basic provisioning example (ansible#55892): The bare minimum example in the docs (i.e. only supplying name, state, and cluster) results in the error `state is present but all of the following are missing: task_definition, desired_count`.

(cherry picked from commit c195645)

* clarify docs for rel src state hard (ansible#55972)

(cherry picked from commit 0b00220)

* correct method docs (ansible#55961)

(cherry picked from commit ea57377)

* Update sample (ansible#55654): Correct logConfiguration example on the ecs_taskdefinition module.

(cherry picked from commit 23ddc77)

* add missing exported state do doc string (ansible#56109)

(cherry picked from commit ba9f0d5)

* package_facts: Trivial docs cleanup (ansible#56015): use
the current YAML style and remove unnecessary quotes around `auto`.

Signed-off-by: Major Hayden <major@redhat.com>
(cherry picked from commit 93d24ef)

* Update include_role description (ansible#56001) to discuss tasks: use

(cherry picked from commit 8cb7640)

* Sync required flags from argument_spec to docs (ansible#56121): arguments for certificate, private_key and password were marked as required in the ArgumentSpec, but not in the documentation. 

(cherry picked from commit 6b474a1)

* updated ec2.py to describe required parameters (ansible#56197): for each option for `state`

(cherry picked from commit 5346a5c)

* Update os_image documentation (ansible#49705) to show auth details

(cherry picked from commit f5326aa)
@sugitk sugitk deleted the patch-2 branch May 27, 2019 06:36
@ansible ansible locked and limited conversation to collaborators Aug 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
affects_2.9 This issue/PR affects Ansible v2.9 aws cloud core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@sugitk @ansibot @acozine