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 - adapted abadger's changelog announcement email into dev process #48172

Merged
merged 7 commits into from
Nov 13, 2018

Conversation

maxamillion
Copy link
Contributor

Signed-off-by: Adam Miller admiller@redhat.com

SUMMARY

Add docs for developer guides about changelog fragments

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs

ANSIBLE VERSION
ansible 2.8.0.dev0 (docs/changelogs 7792f827d2) last updated 2018/11/06 11:01:05 (GMT -500)
  config file = /etc/ansible/ansible.cfg
  configured module search path = [u'/home/admiller/.ansible/plugins/modules', u'/usr/share/ansible/plugins/modules']
  ansible python module location = /home/admiller/src/dev/ansible/lib/ansible
  executable location = /home/admiller/src/dev/ansible/bin/ansible
  python version = 2.7.15 (default, Oct 15 2018, 15:24:06) [GCC 8.1.1 20180712 (Red Hat 8.1.1-5)]

Signed-off-by: Adam Miller <admiller@redhat.com>
@ansibot
Copy link
Contributor

ansibot commented Nov 6, 2018

Hi @maxamillion, thank you for submitting this pull-request!

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Nov 6, 2018

@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. 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 Nov 6, 2018
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.

Thanks for doing this!

Changelogs
----------

Please add a changelog fragment with any PR that is
Copy link
Contributor

Choose a reason for hiding this comment

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

Bullet points for needs/does not need list could make this more readable

docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@acozine acozine left a comment

Choose a reason for hiding this comment

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

Nice addition. As we discussed on IRC, this PR should also deduplicate material here vs. material on https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html#changelogs, and link between them.

docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
@gundalow gundalow removed the needs_triage Needs a first human triage before being processed. label Nov 6, 2018
Copy link
Contributor

@jamescassell jamescassell left a comment

Choose a reason for hiding this comment

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

Thanks for adding this to the Dev guide. I always have to search for it and never remember where it was last time.

@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Nov 6, 2018
Signed-off-by: Adam Miller <admiller@redhat.com>
@ansibot ansibot added needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. and removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. 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 Nov 6, 2018
Signed-off-by: Adam Miller <admiller@redhat.com>
docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
docs/docsite/rst/community/development_process.rst Outdated Show resolved Hide resolved
@maxamillion
Copy link
Contributor Author

Big "Thank You!" to @acozine for picking this up and running with it while I was on PTO. Does this need anything else or is it good to merge?

@acozine
Copy link
Contributor

acozine commented Nov 13, 2018

I think it's ready to go, especially since @gundalow is going to be making additional changes to this page and this section. I think the changes in this PR set the ground-work for the next round of changes.

@gundalow gundalow merged commit 2b1ca25 into ansible:devel Nov 13, 2018
@gundalow
Copy link
Contributor

@maxamillion Thank you for doing this, it's a big help
Thank you everybody for the reviews!

@acozine acozine added this to To do in OLD Ansible Documentation via automation Nov 14, 2018
mjmayer pushed a commit to mjmayer/ansible that referenced this pull request Nov 30, 2018
ansible#48172)

* docs - adapted abadger's changelog announcement email into dev process

Signed-off-by: Adam Miller <admiller@redhat.com>

* migrate changelog docs to one place, add ref to old location

Signed-off-by: Adam Miller <admiller@redhat.com>

* add changes based on feedback

Signed-off-by: Adam Miller <admiller@redhat.com>

* Refines changelog docs, minor re-org of page

* moves links and anchors for new content

* Further reorg of page

* fixes header per jamescassell
Tomorrow9 pushed a commit to Tomorrow9/ansible that referenced this pull request Dec 4, 2018
ansible#48172)

* docs - adapted abadger's changelog announcement email into dev process

Signed-off-by: Adam Miller <admiller@redhat.com>

* migrate changelog docs to one place, add ref to old location

Signed-off-by: Adam Miller <admiller@redhat.com>

* add changes based on feedback

Signed-off-by: Adam Miller <admiller@redhat.com>

* Refines changelog docs, minor re-org of page

* moves links and anchors for new content

* Further reorg of page

* fixes header per jamescassell
@acozine acozine moved this from To do to Done in OLD Ansible Documentation Mar 7, 2019
@ansible ansible locked and limited conversation to collaborators Jul 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.8 This issue/PR affects Ansible v2.8 docs This issue/PR relates to or includes documentation. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

6 participants