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

Edit pass for relocated community documentation. #28368

Merged
merged 12 commits into from
Aug 31, 2017
Merged

Edit pass for relocated community documentation. #28368

merged 12 commits into from
Aug 31, 2017

Conversation

dharmabumstead
Copy link
Contributor

SUMMARY
ISSUE TYPE
  • Feature Pull Request
  • New Module Pull Request
  • Bugfix Pull Request
  • Docs Pull Request
COMPONENT NAME
ANSIBLE VERSION

ADDITIONAL INFORMATION

@ansibot ansibot added affects_2.4 This issue/PR affects Ansible v2.4 feature_pull_request needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Aug 17, 2017
@gregdek
Copy link
Contributor

gregdek commented Aug 17, 2017

Thumbs up from me.

Some of this content is still incorrect -- e.g. the triage bot now runs more or less continually, I believe -- but we'll pick those things out in subsequent pull requests. (Hopefully at a working session at AnsibleFest.)

@ansibot ansibot added needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. and removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. labels Aug 17, 2017
@ansibot
Copy link
Contributor

ansibot commented Aug 17, 2017

The test ansible-test sanity --test rstcheck failed with the following error:

docs/docsite/rst/community/development_process.rst:19:0: Title underline too short.

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Aug 17, 2017
@nitzmahone nitzmahone removed the needs_triage Needs a first human triage before being processed. label Aug 17, 2017
@ansibot ansibot removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Aug 18, 2017
@samdoran
Copy link
Contributor

Making a bunch of improvements to this that will definitely need some review. I believe I made the bot workflow statements more accurate as well as corrected some outdated links. It would also be nice to have @jctanner review the bot workflow to make sure it is accurate.

@samdoran
Copy link
Contributor

Ready to be reviewed.


`Ansible Container List <https://groups.google.com/forum/#!forum/ansible-container>`_ is for users and developers of the Ansible Container project.

`Ansible Lockdown List <https://groups.google.com/forum/#!forum/ansible-lockdown>`_ is for all things related to Ansible Lockdown projects, including DISA STIG automation and CIS Benchmarks.

To subscribe to a group from a non-google account, you can send an email to the subscription address requesting the subscription. For example: ansible-devel+subscribe@googlegroups.com
To subscribe to a group from a non-Google account, you can send an email to the subscription address requesting the subscription. For example: ansible-devel+subscribe@googlegroups.com

IRC Channel
-----------
Copy link
Contributor

Choose a reason for hiding this comment

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

I'll update this to list all the IRC channels.
We can then replace every other reference to mailing lists and IRC with a link to this page.
This would include deleting the list on github.com/ansible/community

@gundalow
Copy link
Contributor

  1. Needs updating so the headings are consistent (as per style guide)

  2. I think we should add .. contents:: Topics on the top of any page with more than two headings, makes it easier to find info

  3. Do we want anchors on any of these headings?

  4. I've added the list of IRC channels. Can all other references to IRC and mailing lists be deleted and replaced with a link to this page

@gundalow
Copy link
Contributor

Can we please leave this PR open for a bit longer. I plan to hack on this during the flight to RDU. Thanks

@dharmabumstead
Copy link
Contributor Author

Absolutely.

@mattclay
Copy link
Member

Closing and re-opening to trigger CI.

@mattclay mattclay closed this Aug 21, 2017
@mattclay mattclay reopened this Aug 21, 2017
@ansibot
Copy link
Contributor

ansibot commented Aug 21, 2017

The test ansible-test sanity --test rstcheck failed with the following errors:

docs/docsite/rst/community/maintainers.rst:12:0: Mismatch: both interpreted text role prefix and reference suffix.
docs/docsite/rst/community/reporting_bugs_and_features.rst:1:0: Title overline & underline mismatch.

click here for bot help

@ansibot ansibot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. labels Aug 29, 2017
@gregdek
Copy link
Contributor

gregdek commented Aug 30, 2017

What do we need to do to get this pushed and live?

@gregdek
Copy link
Contributor

gregdek commented Aug 30, 2017

@dharmabumstead I think we're waiting on one last review from you.

@dharmabumstead
Copy link
Contributor Author

I'll do a last edit pass today. Looks like we've got merge conflicts that will need to be resolved though.

dharmabumstead and others added 8 commits August 30, 2017 16:15
Fixed improper link syntax
Change links to point to new documents
Changed Ansibot to Ansibullbot
Clarified workflow
Change formatting on commans and tags
Add Contents
Use correct headings
@samdoran
Copy link
Contributor

Rebased.

@ansibot ansibot removed needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Aug 30, 2017
@dharmabumstead
Copy link
Contributor Author

dharmabumstead commented Aug 30, 2017 via email

Copy link
Contributor Author

@dharmabumstead dharmabumstead left a comment

Choose a reason for hiding this comment

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

@gregdek and @gundalow - please see comments.

- If the maintainer says ``shipit``, the pull request is labeled **shipit**, whereupon the Core team assesses it for final merge.
- If the maintainer says ``needs_info``, the pull request is labeled **needs_info** and the submitter is asked for more info.
- If the maintainer says **needs_revision**, the pull request is labeled **needs_revision** and the submitter is asked to fix some things.
- If the pull request is labeled **needs_revision** or **needs_info** and has received comments from the submitter...TODO: what happens here?
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This sentence was left unfinsished. What happens in this case?

Copy link
Contributor

Choose a reason for hiding this comment

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

This is out of date anyway and will need to be thoroughly revised when we have time. For now, let's just remove that bullet point.


When you become a power user, your ability and opportunities to help the Ansible project in other ways will multiply quickly.

Ask and answer questions online
-------------------------------

There are many forums online where Ansible users ask and answer questions. Reach out and communicate with your fellow Ansible users. Ask good questions, and give good answers.
There are many forums online where Ansible users ask and answer questions. Reach out and communicate with your fellow Ansible users. Ask good questions, and give good answers.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are there bad questions? Please consider rephrasing.

Copy link
Contributor

Choose a reason for hiding this comment

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

There are bad questions, actually. We could consider linking to this: http://www.catb.org/esr/faqs/smart-questions.html

But for now, let's just delete that "Ask" sentence.


Participate in your local meetup
--------------------------------

There are Ansible meetups `all over the world <https://www.meetup.com/topics/ansible/>`. Join your local meetup. Attend regularly. Ask good questions. Volunteer to give a presentation about how you use Ansible.
There are Ansible meetups `all over the world <https://www.meetup.com/topics/ansible/>`_. Join your local meetup. Attend regularly. Ask good questions. Volunteer to give a presentation about how you use Ansible.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ibid. Are there bad questions? Please consider not using this phrase.

Copy link
Contributor

Choose a reason for hiding this comment

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

Remove "bad".

@@ -41,7 +45,7 @@ Issues for modules are routed to their maintainers via an automated process. Thi
PR Workflow
-----------

Automated routing of pull requests is handled by a tool called [Ansibot](https://github.com/ansible/ansibullbot). (You could say that he moooo-ves things around.)
Automated routing of pull requests is handled by a tool called [Ansibot](https://github.com/ansible/ansibullbot). (You could say that he moooo-ves things around.)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Cute, but adding stuff like this to the documentation is creating a localization nightmare further down the road. Please remove.

Copy link
Contributor

Choose a reason for hiding this comment

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

OK, cut the pun.

Copy link
Contributor Author

@dharmabumstead dharmabumstead left a comment

Choose a reason for hiding this comment

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

Edit and review finished. Good to merge.

@dharmabumstead dharmabumstead merged commit b146e17 into ansible:devel Aug 31, 2017
prasadkatti pushed a commit to prasadkatti/ansible that referenced this pull request Oct 1, 2017
* Edit pass for relocated community documentation.

* Updated info on Ansibullbot

Fixed improper link syntax
Change links to point to new documents
Changed Ansibot to Ansibullbot
Clarified workflow
Change formatting on commans and tags

* Update communication.rst

Add Contents
Use correct headings

* Update communication.rst

* Topics, remove whitespace, codeofconduct

* Formatting

* Correct heading

* Update maintainers.rst

* Minor edits and a request for more info

* Removed some hard-to-localize wording.

* Removed incomplete sentence

* Minor edits per review
@ansibot ansibot added feature This issue/PR relates to a feature request. and removed feature_pull_request labels Mar 5, 2018
@ansible ansible locked and limited conversation to collaborators Apr 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.4 This issue/PR affects Ansible v2.4 feature This issue/PR relates to a feature request. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants