Commit graph

126 commits

Author SHA1 Message Date
Sviatoslav Sydorenko
dfaa72297c Fix an RST link to the changelog config in docs 2019-06-05 15:08:09 +02:00
Bill Nottingham
c493593b4b Adjust assorted terminology and wording around product offerings. (#57242)
* Adjust assorted terminology and wording around product offerings.

* Update docs/docsite/rst/dev_guide/style_guide/trademarks.rst
* Update docs/docsite/rst/user_guide/modules_support.rst
* Update docs/docsite/rst/reference_appendices/tower.rst
2019-05-31 14:24:44 -05:00
Sviatoslav Sydorenko
5183f84016 📝 Mention the minumum cherry-picker version in doc (#57139) 2019-05-29 13:39:10 -05:00
Kevin Breit
4742897635 Move backport guide to 2.8 (#56578)
The backport guide should refer to Ansible 2.8 instead of 2.7 as the target branch, since 2.8 is out.
2019-05-17 21:16:36 -05:00
Felix Fontein
6948e04276
Add myself to committer list. (#56363) 2019-05-13 19:22:02 +02:00
Caio Ramos
3bbc083818 Updating working groups links to community wiki (#54482)
Updating working groups links to community wiki and adding Working Groups wiki link (https://github.com/ansible/community/wiki#working-groups)
+label: docsite_pr
2019-03-29 08:41:19 -05:00
Toshio Kuratomi
f5f4948480
Remove nose from unittests (#54055)
* Remove nose from unittests

This PR migrates the last of our unittests from using nose to using
pytest.  We don't need to install nose in our testing environments
anymore
2019-03-19 18:36:45 -07:00
Sandra McCann
2c0897caf2 mention ansible-lint and editor tools that help with playbook development (#51769)
* introduce ansible-lint in playbook docs, mention editors help playbook syntax

Co-Authored-By: samccann <samccann@redhat.com>
2019-02-06 14:56:52 -06:00
mclean
8e9a5c8de7 changes 'github' to 'GitHub' in community (#51111)
* changes 'github' to 'GitHub' in community
2019-01-24 14:28:39 -06:00
Simon Legner
33b9c880a4 Consistent typesetting of "GitHub" (#50929) 2019-01-15 14:53:04 +01:00
Bianca Henderson
52843fcabc Making changes to the Community Guide index (#49670) 2018-12-12 13:49:00 -06:00
John R Barker
c3d579c52a Docker & Remote Management Working Groups (#49023)
* Adds Docker & Remote Management Working Groups
2018-11-26 13:27:47 -06:00
John R Barker
3433ca286d Docs reorg /community/index & /dev_guide/index (#48734)
* Improved community/index.rst makes it easier to find existing content
2018-11-26 13:00:26 -06:00
Martin Krizek
9ce9c9698a committer_guidelines.rst: update core committers (#48662)
* committer_guidelines.rst: update core committers

* Another update
2018-11-14 15:07:57 -05:00
Adam Miller
2b1ca25e59 docs - adapted abadger's changelog announcement email into dev process (#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
2018-11-13 22:42:02 +00:00
Andreas Krüger
806442b3ec Document the tests that are currently run on documentation pull requests. (#48436) 2018-11-13 08:39:00 -06:00
Bianca Henderson
e38796bf7b Slight Change in Wording in "Reporting Bugs and Features" (#47984)
* Adding a link for PR info

* Not specifying Google Groups in wording
2018-11-02 14:48:30 -04:00
Bianca Henderson
248827227a Correcting syntax of PyYAML package (#47987) 2018-11-02 11:46:56 -05:00
John R Barker
f536944e3a Molecule is now IRC: ansible-molecule (#47860) 2018-10-31 09:42:56 -04:00
John R Barker
4572d9ccd7
ansible-lint and molecule part of Red Hat (#47826) 2018-10-30 18:54:10 +00:00
Bianca Henderson
e6d99cb2bf Adding a link for PR info (#47778) 2018-10-30 09:54:42 -05:00
John R Barker
d189e58f63 Correct AWX community link (#47742) 2018-10-29 08:11:37 -04:00
John R Barker
749af9fd22 Document all Working Group, email lists and IRC channels (#47615)
Put all communication info in one place so we can update links to point here.
2018-10-28 18:52:34 -05:00
John R Barker
166e84b9c4 Docs: No need to follow up on backport PRs (#47616)
Also tidy up `notes` section into a single box
2018-10-28 16:40:39 -05:00
Alicia Cozine
4219d25fc7 Add docs about contributing to docs (#46481)
* adds page on community contributions to docs
2018-10-24 11:14:01 -04:00
Haidara Mohamed El Mouctar
cd4415d4ec Docsite: Add a new tool: Ansible Playbook Grapher (#46435)
Add Ansible Playbook Grapher: a tool create a graph representing your Ansible playbook tasks and roles.

https://github.com/haidaraM/ansible-playbook-grapher

+label: docsite_pr
2018-10-03 10:19:19 -05:00
Alicia Cozine
f430f60541
Restore license agreement (#45809)
* adds page for CLA in community docs with links from dev and community docs
2018-09-18 14:47:22 -05:00
Alicia Cozine
4264be2b18 Remove more docs build errors (#45364)
* orphans testing pages to avoid not-in-toctree errors

* orphans various pages pending reorg

* adds module_utils and special_vars to main TOC

* uses a glob for scenario_guide TOC

* normalize and Sentence-case headings on community pages, typos

* re-orgs community TOC, adds all pages to toctree

* removes scenario guides index page

* adds style guide to community index

* basic update to style guide

* fix typo that created a new error

* removes not-in-toctree from ignore errors list

* leave removing files for future cleanup task
2018-09-11 17:51:47 +01:00
Sam Doran
5d6f844eba Add docs on how to write changelog fragments (#42428)
* Add docs on how to write changelog fragments

* Make recommended changes

* Restore lines and make recommended changes

* Add link to new style changelog

Remove redundant mention of old style changelog
2018-09-11 12:23:22 -04:00
Alicia Cozine
9a76441c02
rewrite of the developer guide, part 1 (#45179)
* rewrite of the developer guide, part 1
2018-09-07 08:57:36 -05:00
Andreas Olsson
00e5123e4c Update documentation based on 301 permanent redirects (#43675) 2018-08-13 14:54:14 -05:00
Andreas Olsson
4a0b32083c Fix link description typo in tools documentation (#43828) 2018-08-08 16:03:50 -07:00
Andreas Olsson
1a11cecaef Prefer https:// links in the docs site
All the changed urls are availible by way of https://. Most of them
already redirect.
2018-08-01 08:20:40 -07:00
John R Barker
321081c3b4 atom & yamllint (#43498)
* atom & yamllint
2018-07-31 14:22:38 -05:00
Ajay Chenampara
d79027b77f Update with Emacs info (#43450)
* Update other_tools_and_programs with Emacs info
2018-07-30 16:23:33 -05:00
John R Barker
3ab9030f05 Document more tools (#43053)
* Document more tools
2018-07-26 17:23:00 -05:00
Sviatoslav Sydorenko
97cc0cce7f
🚸 🐍 🍒 ⛏ Integrate cherry picker (#41403)
This enables developers to use cherry-picker for backporting purposes.
This tool originally comes from Core Python Development Workflow.

Ref: https://pypi.org/p/cherry-picker
Ref: https://github.com/python/core-workflow/tree/master/cherry_picker

Also:
* 📝 Add docs about supporting cherry-picker
2018-07-12 19:34:02 +03:00
Sam Doran
3e2a4f67cf
Update link to GitHub admin process (#42364) 2018-07-05 15:38:52 -04:00
Alexandre Vicenzi
df2e0c7c00 Fix broken links. (#42323) 2018-07-04 18:54:49 -07:00
David Moreau Simard
8c27ffdf90 Add ARA Records Ansible to community tools (#39836)
ARA is an Ansible callback that records playbook run data in a local
or remote database. This data is exposed through a CLI client as well
as a reporting web application.
2018-05-07 22:18:52 -04:00
Andrew Gaffney
4134f1204b Add Andrew Gaffney to list of people in Committers Guidelines doc 2018-05-01 12:51:34 -07:00
Alicia Cozine
4b52a54e18 Reduce warnings (#39254)
* removes FAQ links; no entries exist for linked config settings

* fixes various anchors and links

* addresses abadger comments, thanks

* marks orphan pages, avoids TOC errors

* adds links for remote_tmp setting to FAQ
2018-04-25 11:18:52 -07:00
Alicia Cozine
bbfd6c6ab1 Internal refs (#39094)
* fixes community refs

* fixes appendix refs

* fixes scenario refs, keeps ACI guide link to devel

* fixes windows refs

* fixes user guide refs

* fixes dev guide refs
2018-04-20 12:17:02 -07:00
John R Barker
c4e298b808 Correct to development_process (#39069) 2018-04-20 12:36:29 -05:00
Alicia Cozine
408e29cbd2 Link fixes (#39038)
* fixes links on plugins pages

* fixes links in community pages

* fixes links in user guide

* adds anchors on playbooks pages
2018-04-19 17:02:30 -07:00
Brian Coca
ce8c336d52 added ref to ansilbe molecule 2018-04-18 12:19:09 -04:00
scottb
6454aedb44
Reinstate code of conduct to the community TOC; add links to code of conduct to a few conspicuous spots in the community guide. (#38501) 2018-04-09 16:16:45 -07:00
Martin Krizek
bcfff1c818 docs: needs_rebase is still used (#37774) 2018-03-23 00:51:53 -07:00
scottb
381359a8f8
Doc build warning/broken link clean-a-palooza (#37382)
* Doc build warning/broken link clean-a-palooza, WIP commit 1.

* Fixed broken anchor

* Fixing additional broken links; converting from doc to ref.

* Fix anchor
2018-03-14 12:44:21 -07:00
Matt Martz
076ea07bb5
Add instructions for creating backport PRs (#36593)
* Add instructions for creating backport PRs

* Update development_process.rst

simpler workflow

* Update development_process.rst

added origin note

* A few adjustments to clarity, use backport instead of cherry pick in branch name

* Address formatting issue

* fetch isn't a flag

* Fix rst formatting
2018-02-23 09:51:36 -06:00
scottb
373b1dcf59
Core Docs Refactor and Redesign (#36067)
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.

* Adding extra blank line for shippable
2018-02-13 07:23:55 -08:00
John R Barker
3fadc5d614 Formatting and broken links (#35226) 2018-01-25 13:06:03 -08:00
Toshio Kuratomi
94d952f94b
Documentation on how to make a release. (#31426)
* Release Engineering Docs with pointer to the Docs on how to actually make the release.
2017-12-21 08:14:49 -08:00
John R Barker
6e4aa49a31 No hardcoding roadmaps (#32981) 2017-11-16 08:03:10 -08:00
Lindsay Hill
146f90e16b Fixed RST hyperlink issues (#31394) 2017-10-06 01:30:10 -07:00
Toshio Kuratomi
c82cf791dd Add a code-smell test for smart quotes and remove smart quotes from all files 2017-09-18 16:49:16 -07:00
Will Thames
c749ecbd94 Add ansible-inventory-grapher to the list of tools (#29068)
* Add ansible-inventory-grapher to the list of tools

* Fixed minor typo.
2017-09-08 00:19:18 +00:00
scottb
b146e17733 Edit pass for relocated community documentation. (#28368)
* 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
2017-08-31 12:14:35 -07:00
Chris Houseknecht
d513c430de Updates community code of conduct email 2017-08-29 12:36:45 -04:00
Toshio Kuratomi
84ea2af4b6 Remove nonexistent special_interest-groups doc 2017-08-22 11:52:30 -07:00
Greg DeKoenigsberg
d78c199972 Update triage_process.rst to link to ansibullbot (#28137)
* Update triage_process.rst to link to ansibullbot

* fix typo
2017-08-14 00:03:40 -04:00
Greg DeKoenigsberg
75c0c545fd Create other_tools_and_programs (#28138)
* Create other_tools_and_programs

From https://github.com/ansible/community/issues/5.

* Fix typo
2017-08-13 22:32:28 -04:00
Greg DeKoenigsberg
b3ed699132 Copying code of conduct from community.rst (#28136) 2017-08-13 21:01:07 -04:00
Greg DeKoenigsberg
608c69279c Moving "communication" info from main community page (#28135) 2017-08-13 20:28:20 -04:00
Greg DeKoenigsberg
5f6bfd81f8 Copying content from MODULE_GUIDELINES.md (#28131) 2017-08-13 17:13:54 -04:00
Adrian Likins
a2c8b03b46 fix rst format errors making rstcheck fail (#28129) 2017-08-13 15:59:13 -04:00
Greg DeKoenigsberg
3ec7e030bf Completed draft of How Can I Help 2017-08-13 14:35:40 -04:00
Greg DeKoenigsberg
f8f17c0c27 Add basic info on pull requests 2017-08-13 14:19:30 -04:00
Greg DeKoenigsberg
418dd0cd4a Iterating on How Can I Help
A little more content
2017-08-13 13:43:02 -04:00
Greg DeKoenigsberg
ba065637ff Add roadmap to development process doc 2017-08-13 13:08:33 -04:00
Greg DeKoenigsberg
792bfa657c formatting tweak 2017-08-13 12:39:03 -04:00
Greg DeKoenigsberg
e43d1da938 formatting tweak 2017-08-13 12:37:46 -04:00
Greg DeKoenigsberg
d6028c5de4 Slight changes to reporting bugs and features
as recommended by @gundalow in review for #27911
2017-08-13 12:36:03 -04:00
Greg DeKoenigsberg
ebfdbfb819 New content for bugs and features (#27911)
1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.)

2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 12:31:57 -04:00
Greg DeKoenigsberg
aca4504e96 Simple "good enought" index page (#27667)
Removing the FIXME, just a peppy little starter page.
2017-08-02 21:51:58 +01:00
scottb
3476b005b9 Initial pass at consolidating community content [work in progress] (#27661)
* Added placeholder topics for community info

* Setup community section index.

* Initial move of triage process docs.

* Typo/test

* Removed triage topic from index.
2017-08-02 12:38:29 -07:00