1. ansible
  2. Commit 4312391e0ac1f5a218f4048a75c5200ca8de10d5
Browse code

(A) Fix a bug in the doc generator that was clobbering the force parameter for the copy module.

(B) This is a work in progress but the idea is to have text snippets where we can respond to tickets with a bit more helpful info.
Not active just yet.

Michael DeHaan authored on 2014/08/06 09:08:31
Showing 10 changed files
lib/ansible/utils/module_docs.py
History View file @ 4312391
... ... 
@@ -85,7 +85,9 @@ def get_docstring(filename, verbose=False):
85 85 
                             if not doc.has_key(key):
86 86 
                                 doc[key] = value
87 87 
                             else:
88 
-                                doc[key].update(value)
88 
+                                # not sure this is the only example but don't do this for the copy module
89 
+                                if key != 'force':
90 
+                                    doc[key].update(value)
89 91
90 92 
                 if 'EXAMPLES' in (t.id for t in child.targets):
91 93 
                     plainexamples = child.value.s[1:]  # Skip first empty line
ticket_stubs/another_project.md
History View file @ 4312391
92 94 
new file mode 100644
... ... 
@@ -0,0 +1,23 @@
0 
+Should This Be Filed Elsewhere?
1 
+===============================
2 
+
3 
+Hi!
4 
+
5 
+Thanks very much for your interest in Ansible.  It sincerely means a lot to us.
6 
+
7 
+This appears to be something that should be filed against another project or bug tracker, and let us explain our reasons for thinking this:
8 
+
9 
+   * FILL IN
10 
+
11 
+If you can stop by the tracker or forum for one of those projects, we'd appreciate it.
12 
+
13 
+Should you still wish to discuss things further, or if you disagree with our thought process, please stop by one of our two mailing lists:
14 
+
15 
+  * https://groups.google.com/forum/#!forum/ansible-project
16 
+  * https://groups.google.com/forum/#!forum/ansible-devel
17 
+
18 
+We'd be happy to discuss things.
19 
+
20 
+Thank you once again!
21 
+
22 
+
ticket_stubs/cleanup_commits.md
History View file @ 4312391
0 23 
new file mode 100644
... ... 
@@ -0,0 +1,26 @@
0 
+Cleanup Request
1 
+===============
2 
+
3 
+Hi!
4 
+
5 
+Thanks very much for your submission to Ansible.  It sincerely means a lot to us.
6 
+
7 
+We do require submissions to be free of merge commits, which cause difficulties in reviewing and merging code, and also affect the history of the source tree.
8 
+To resolve this problem, it may be helpful to create a new branch and cherry-pick commits onto it.
9 
+
10 
+   * In general, always start a "topic branch" named after each thing you would like to contribute
11 
+   * use "git pull --rebase" vs "git pull" to stay in tune with upstream, as well as "git rebase" vs "git merge"
12 
+   * if you have things broken out over many commits, consider submitting just one squashed commit that keeps the history concise
13 
+
14 
+Just as a quick reminder of things, this is a really busy project.  We have over 800 contributors and to manage the queue effectively
15 
+we assign things a priority between P1 (highest) and P5.  We'd like to thank you very much for your time!
16 
+We'll work things in priority order, so just wanted you to be aware of the queue and know we haven't forgot about you!
17 
+
18 
+We will definitely see your comments on this issue when reading this ticket, but may not be able to reply promptly.  You may also wish to join one of our two mailing lists
19 
+which is very active:
20 
+
21 
+   * https://groups.google.com/forum/#!forum/ansible-devel - for user questions, tips, and tricks
22 
+   * https://groups.google.com/forum/#!forum/ansible-project - for strategy, future planning, and questions about writing code
23 
+
24 
+Thank you once again for this and your interest in Ansible!
25 
+
ticket_stubs/need_info.md
History View file @ 4312391
0 26 
new file mode 100644
... ... 
@@ -0,0 +1,23 @@
0 
+Information Request
1 
+===================
2 
+
3 
+Hi!
4 
+
5 
+Thanks very much for your submission to Ansible.  It sincerely means a lot to us.
6 
+
7 
+We have some questions we'd like to know about before we can get this request queued up.   If you can help answer them, we'd greatly appreciate it:
8 
+
9 
+   * (A) INSERT QUESTION HERE
10 
+
11 
+Just as a quick reminder of things, this is a really busy project.  We have over 800 contributors and to manage the queue effectively
12 
+we assign things a priority between P1 (highest) and P5.  We'd like to thank you very much for your time!
13 
+We'll work things in priority order, so just wanted you to be aware of the queue and know we haven't forgot about you!
14 
+
15 
+We will definitely see your comments on this issue when reading this ticket, but may not be able to reply promptly.  You may also wish to join one of our two mailing lists
16 
+which is very active:
17 
+
18 
+   * https://groups.google.com/forum/#!forum/ansible-devel - for user questions, tips, and tricks
19 
+   * https://groups.google.com/forum/#!forum/ansible-project - for strategy, future planning, and questions about writing code
20 
+
21 
+Thank you once again for this and your interest in Ansible!
22 
+
ticket_stubs/need_revision.md
History View file @ 4312391
0 23 
new file mode 100644
... ... 
@@ -0,0 +1,23 @@
0 
+Revision Request
1 
+================
2 
+
3 
+Hi!
4 
+
5 
+Thanks very much for your submission to Ansible.  It sincerely means a lot to us.
6 
+
7 
+We'd like to see a few things tweaked if you don't mind.  If you can help resolve these items, we'd greatly appreciate it:
8 
+
9 
+   * (A) INSERT ITEM HERE
10 
+
11 
+Just as a quick reminder of things, this is a really busy project.  We have over 800 contributors and to manage the queue effectively
12 
+we assign things a priority between P1 (highest) and P5.  We'd like to thank you very much for your time!
13 
+We'll work things in priority order, so just wanted you to be aware of the queue and know we haven't forgot about you!
14 
+
15 
+We will definitely see your comments on this issue when reading this ticket, but may not be able to reply promptly.  You may also wish to join one of our two mailing lists
16 
+which is very active:
17 
+
18 
+   * https://groups.google.com/forum/#!forum/ansible-devel - for user questions, tips, and tricks
19 
+   * https://groups.google.com/forum/#!forum/ansible-project - for strategy, future planning, and questions about writing code
20 
+
21 
+Thank you once again for this and your interest in Ansible!
22 
+
ticket_stubs/no_thanks.md
History View file @ 4312391
0 23 
new file mode 100644
... ... 
@@ -0,0 +1,20 @@
0 
+Question About This One
1 
+=======================
2 
+
3 
+Hi!
4 
+
5 
+Thanks very much for your submission to Ansible.  It sincerely means a lot to us that you've taken time to contribute.
6 
+
7 
+Unfortunately, we're not sure if we want this feature in the program, and I don't want this to seem confrontational.  Our reasons for this are:
8 
+
9 
+   * (A) INSERT ITEM HERE
10 
+
11 
+However, we're absolutely always up for discussion.  Since this is a really busy project, we don't always see comments on closed tickets, but want to encourage
12 
+open dialog.  You can stop by the development list, and we'd be glad to talk about it - and we might even be persuaded otherwise!
13 
+
14 
+   * https://groups.google.com/forum/#!forum/ansible-devel - for user questions, tips, and tricks
15 
+
16 
+In the future, sometimes starting a discussion on the development list prior to implenting a feature can make getting things included a little easier, but it's not always neccessary.
17 
+
18 
+Thank you once again for this and your interest in Ansible!
19 
+
ticket_stubs/not_a_bug.md
History View file @ 4312391
0 20 
new file mode 100644
... ... 
@@ -0,0 +1,21 @@
0 
+Is This A Bug?
1 
+==============
2 
+
3 
+Hi!
4 
+
5 
+Thanks very much for your submission to Ansible.  It sincerely means a lot to us.
6 
+
7 
+We're not sure this is a bug, and we don't mean for this to be confrontational.  Let's explain what we're thinking:
8 
+
9 
+   * INSERT ITEM HERE
10 
+
11 
+As such, we're going to close this ticket.  However, we're open to being corrected, should you wish to discuss.  You can stop by one of our two mailing lists
12 
+to talk about this and we might be persuaded otherwise.
13 
+
14 
+   * https://groups.google.com/forum/#!forum/ansible-devel - for user questions, tips, and tricks
15 
+   * https://groups.google.com/forum/#!forum/ansible-project - for strategy, future planning, and questions about writing code
16 
+
17 
+Comments on closed tickets aren't something we monitor, so if you do disagree with this, a mailing list thread is probably appropriate.
18 
+
19 
+Thank you once again for this and your interest in Ansible!
20 
+
ticket_stubs/questions_to_list.md
History View file @ 4312391
0 21 
new file mode 100644
... ... 
@@ -0,0 +1,17 @@
0 
+List Information
1 
+================
2 
+
3 
+Hi!
4 
+
5 
+Thanks very much for your interest in Ansible.  It sincerely means a lot to us.
6 
+
7 
+This appears to be a user question, and we'd like to direct these kinds of things to either the mailing list or the IRC channel.
8 
+
9 
+   * IRC: #ansible on irc.freenode.net
10 
+   * mailing list: https://groups.google.com/forum/#!forum/ansible-project
11 
+
12 
+If you can stop by there, we'd appreciate it.  This allows us to keep the issue tracker for bugs, pull requests, RFEs and the like.
13 
+
14 
+Thank you once again and we look forward to seeing you on the list or IRC.  Thanks!
15 
+
16 
+
ticket_stubs/resolved.md
History View file @ 4312391
0 17 
new file mode 100644
... ... 
@@ -0,0 +1,20 @@
0 
+Closing This Ticket
1 
+===================
2 
+
3 
+Hi!
4 
+
5 
+We believe recent commits (likely detailed above) should resolve this question or problem for you.
6 
+
7 
+This will also be included in the next major release.
8 
+
9 
+If you continue seeing any problems related to this issue, or if you have any further questions, please let us know by stopping by one of the two mailing lists, as appropriate:
10 
+
11 
+   * https://groups.google.com/forum/#!forum/ansible-devel - for user questions, tips, and tricks
12 
+   * https://groups.google.com/forum/#!forum/ansible-project - for strategy, future planning, and questions about writing code
13 
+
14 
+Because this project is very active, we're unlikely to see comments made on closed tickets, but the mailing list is a great way to ask questions, or post if you don't think this particular
15 
+issue is resolved.
16 
+
17 
+Thank you!
18 
+
19 
+
ticket_stubs/thanks.md
History View file @ 4312391
0 20 
new file mode 100644
... ... 
@@ -0,0 +1,21 @@
0 
+Submission Recieved
1 
+===================
2 
+
3 
+Hi!
4 
+
5 
+Thanks very much for your submission to Ansible.  It sincerely means a lot to us.
6 
+
7 
+Just as a quick reminder of things, this is a really busy project.  We have over 800 contributors and to manage the queue effectively
8 
+we assign things a priority between P1 (highest) and P5.
9 
+
10 
+We may also ask some questions and it may be a while before we can get to this, but we'd like to thank you very much for your time!
11 
+We'll work things in priority order, so just wanted you to be aware of the queue and know we haven't forgot about you!
12 
+
13 
+We will definitely see your comments on this issue when reading this ticket, but may not be able to reply promptly.  You may also wish to join one of our two mailing lists
14 
+which is very active:
15 
+
16 
+   * https://groups.google.com/forum/#!forum/ansible-devel - for user questions, tips, and tricks
17 
+   * https://groups.google.com/forum/#!forum/ansible-project - for strategy, future planning, and questions about writing code
18 
+
19 
+Thank you once again for this and your interest in Ansible!
20 
+