From dadd9425d04abfcdcddb87fa60cea6f54f1efee4 Mon Sep 17 00:00:00 2001
From: René Genz
Date: Nov 22 2017 08:42:13 +0000
Subject: expand using doc repo; fix spelling mistakes
Signed-off-by: René Genz
---
diff --git a/doc/usage/using_doc.rst b/doc/usage/using_doc.rst
index e81ffa1..5be03cf 100644
--- a/doc/usage/using_doc.rst
+++ b/doc/usage/using_doc.rst
@@ -3,30 +3,51 @@ Using the doc repository of your project
In this section of the documentation, we are interested in the doc repository.
-The doc repository is a simple git repo, whose content will appear under the
-`Docs` tab in pagure and on https://docs.pagure.org//.
+The doc repository is a simple Git repo, whose content will appear in 2 ways:
-There are a few ways you can put your documentation in this repo:
+* inline under the `Docs` tab in Pagure:
-* Simple text files
+ * either https://pagure.io/docs//
-Pagure will display them as plain text. If one of these is named ``index``
-it will be presented as the front page.
+ * or https://pagure.io/docs///
-* rst or markdown files
+* standalone:
-Pagure will convert them to html on the fly and display them as such.
-The rst files must end with `.rst` and the markdown ones must end with
-``.mk``, ``.md`` or simply ``.markdown``.
+ * either https://docs.pagure.org//
-* html files
+ * or https://docs.pagure.org/./
-Pagure will simply show them as such.
+By default the `Docs` tab in the project's menu is disabled, you
+will have to visit the project's settings page and turn it on
+in the ``Project options`` section.
-.. note: By default the `Docs` tab in the project's menu is disabled, you
- will have to visit the project's settings page and turn it on
- in the ``Project options`` section.
+
+The URL to the doc repository is:
+
+* either https://pagure.io//docs/
+
+* or https://pagure.io//docs/
+
+Different file types can be used for your documentation in this repo:
+
+* simple text files
+
+ Pagure will display them as plain text. If one of these is named ``index``
+ it will be presented as the front page.
+
+* RST or markdown files
+
+ Pagure will convert them to HTML on the fly and display them as such.
+ The RST files must end with ``.rst`` and the markdown ones must end with
+ ``.mk``, ``.md`` or simply ``.markdown``.
+
+* HTML files
+
+ Pagure will simply show them as such.
+
+Updating documentation hosted in a dedicated repo is like
+`using other repos `_.
Example
@@ -35,7 +56,7 @@ Example
Pagure's documentation is kept in pagure's sources, in the `doc` folder there.
You can see it at: `https://pagure.io/pagure/blob/master/f/doc
`_. This doc can be built with
-`sphinx `_ to make it html and prettier.
+`Sphinx `_ to make it HTML and prettier.
The built documentation is available at: `https://docs.pagure.org/pagure/
`_.
diff --git a/pagure/api/__init__.py b/pagure/api/__init__.py
index 7bbafd3..6ce2212 100644
--- a/pagure/api/__init__.py
+++ b/pagure/api/__init__.py
@@ -61,7 +61,7 @@ class APIERROR(enum.Enum):
ETRACKERDISABLED = 'Issue tracker disabled for this project'
EDBERROR = 'An error occured at the database level and prevent the ' \
'action from reaching completion'
- EINVALIDREQ = 'Invalid or incomplete input submited'
+ EINVALIDREQ = 'Invalid or incomplete input submitted'
EINVALIDTOK = 'Invalid or expired token. Please visit %s to get or '\
'renew your API token.' % APP.config['APP_URL']
ENOISSUE = 'Issue not found'
diff --git a/pagure/api/issue.py b/pagure/api/issue.py
index d7a02b7..d121b3d 100644
--- a/pagure/api/issue.py
+++ b/pagure/api/issue.py
@@ -196,7 +196,7 @@ def api_new_issue(repo, username=None, namespace=None):
| | | | list of milestones set |
| | | | in the project |
+-------------------+--------+-------------+---------------------------+
- | ``tag`` | string | Optional | | Coma separated list of |
+ | ``tag`` | string | Optional | | Comma separated list of |
| | | | tags to link to this |
| | | | ticket from the list of |
| | | | tags in the project |
diff --git a/pagure/cli/admin.py b/pagure/cli/admin.py
index 3114284..ad4ccfb 100644
--- a/pagure/cli/admin.py
+++ b/pagure/cli/admin.py
@@ -536,7 +536,7 @@ def do_create_admin_token(args):
print('%s. %s' % (idx, acl))
print('Which ACLs do you want to associated with this token?')
- acls = _get_input('(Coma separated list): ')
+ acls = _get_input('(Comma separated list): ')
acls_idx = [int(acl.strip()) for acl in acls.split(',')]
acls = [acls_list[acl] for acl in acls_idx]
diff --git a/pagure/lib/notify.py b/pagure/lib/notify.py
index 3ff5018..625c848 100644
--- a/pagure/lib/notify.py
+++ b/pagure/lib/notify.py
@@ -217,7 +217,7 @@ def send_email(text, subject, to_mail,
:arg text: the content of the email to send
:arg subject: the subject of the email
:arg to_mail: a string representing a list of recipient separated by a
- coma
+ comma
:kwarg mail_id: if defined, the header `mail-id` is set with this value
:kwarg in_reply_to: if defined, the header `In-Reply-To` is set with
this value
diff --git a/tests/test_pagure_flask_api_auth.py b/tests/test_pagure_flask_api_auth.py
index 567959f..0a63fb7 100644
--- a/tests/test_pagure_flask_api_auth.py
+++ b/tests/test_pagure_flask_api_auth.py
@@ -126,7 +126,7 @@ class PagureFlaskApiAuthtests(tests.SimplePagureTest):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"issue_content": ["This field is required."],
diff --git a/tests/test_pagure_flask_api_fork.py b/tests/test_pagure_flask_api_fork.py
index 4d13c7e..5c10619 100644
--- a/tests/test_pagure_flask_api_fork.py
+++ b/tests/test_pagure_flask_api_fork.py
@@ -813,7 +813,7 @@ class PagureFlaskApiForktests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"comment": ["This field is required."]}
}
@@ -927,7 +927,7 @@ class PagureFlaskApiForktests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"comment": ["This field is required."]}
}
@@ -1040,7 +1040,7 @@ class PagureFlaskApiForktests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"comment": ["This field is required."]}
}
@@ -1188,7 +1188,7 @@ class PagureFlaskApiForktests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"comment": ["This field is required."]}
}
diff --git a/tests/test_pagure_flask_api_issue.py b/tests/test_pagure_flask_api_issue.py
index 1b70cc4..4665619 100644
--- a/tests/test_pagure_flask_api_issue.py
+++ b/tests/test_pagure_flask_api_issue.py
@@ -326,7 +326,7 @@ class PagureFlaskApiIssuetests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"issue_content": ["This field is required."],
@@ -360,7 +360,7 @@ class PagureFlaskApiIssuetests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"issue_content": ["This field is required."],
@@ -389,7 +389,7 @@ class PagureFlaskApiIssuetests(tests.Modeltests):
}
)
- # Valid request but invalid milestone
+ # Valid request but invalid milestone
data = {
'title': 'test issue',
'issue_content': 'This issue needs attention',
@@ -402,7 +402,7 @@ class PagureFlaskApiIssuetests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"milestone": [
@@ -583,7 +583,7 @@ class PagureFlaskApiIssuetests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"issue_content": ["This field is required."],
@@ -599,7 +599,7 @@ class PagureFlaskApiIssuetests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"issue_content": ["This field is required."],
@@ -633,7 +633,7 @@ class PagureFlaskApiIssuetests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"issue_content": ["This field is required."],
@@ -2041,7 +2041,7 @@ class PagureFlaskApiIssuetests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"milestone": [
diff --git a/tests/test_pagure_flask_api_issue_change_status.py b/tests/test_pagure_flask_api_issue_change_status.py
index 6db1112..34bad1f 100644
--- a/tests/test_pagure_flask_api_issue_change_status.py
+++ b/tests/test_pagure_flask_api_issue_change_status.py
@@ -175,7 +175,7 @@ class PagureFlaskApiIssueChangeStatustests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"status": ["Not a valid choice"]}
}
diff --git a/tests/test_pagure_flask_api_issue_comment.py b/tests/test_pagure_flask_api_issue_comment.py
index afd07ae..94ee8e5 100644
--- a/tests/test_pagure_flask_api_issue_comment.py
+++ b/tests/test_pagure_flask_api_issue_comment.py
@@ -154,7 +154,7 @@ class PagureFlaskApiIssueCommenttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"comment": ["This field is required."]}
}
@@ -317,7 +317,7 @@ class PagureFlaskApiIssueCommenttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"comment": ["This field is required."]}
}
diff --git a/tests/test_pagure_flask_api_issue_custom_fields.py b/tests/test_pagure_flask_api_issue_custom_fields.py
index e0f1e02..41d3e25 100644
--- a/tests/test_pagure_flask_api_issue_custom_fields.py
+++ b/tests/test_pagure_flask_api_issue_custom_fields.py
@@ -69,7 +69,7 @@ class PagureFlaskApiCustomFieldIssuetests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
}
)
diff --git a/tests/test_pagure_flask_api_project.py b/tests/test_pagure_flask_api_project.py
index 5477522..4327b52 100644
--- a/tests/test_pagure_flask_api_project.py
+++ b/tests/test_pagure_flask_api_project.py
@@ -1687,7 +1687,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
data='invalid')
self.assertEqual(output.status_code, 400)
expected_error = {
- 'error': 'Invalid or incomplete input submited',
+ 'error': 'Invalid or incomplete input submitted',
'error_code': 'EINVALIDREQ'
}
self.assertEqual(json.loads(output.data), expected_error)
@@ -1709,7 +1709,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
data={'invalid': 'invalid'})
self.assertEqual(output.status_code, 400)
expected_error = {
- 'error': 'Invalid or incomplete input submited',
+ 'error': 'Invalid or incomplete input submitted',
'error_code': 'EINVALIDREQ'
}
self.assertEqual(json.loads(output.data), expected_error)
@@ -1962,7 +1962,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"name": ["This field is required."],
@@ -1983,7 +1983,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"description": ["This field is required."]}
}
@@ -2082,7 +2082,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"name": ["This field is required."],
@@ -2103,7 +2103,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"description": ["This field is required."]}
}
@@ -2159,7 +2159,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"namespace": [
@@ -2265,7 +2265,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"repo": ["This field is required."]}
}
@@ -2283,7 +2283,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"repo": ["This field is required."]}
}
@@ -2389,7 +2389,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"repo": ["This field is required."]}
}
@@ -2407,7 +2407,7 @@ class PagureFlaskApiProjecttests(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"repo": ["This field is required."]}
}
diff --git a/tests/test_pagure_flask_api_ui_private_repo.py b/tests/test_pagure_flask_api_ui_private_repo.py
index 292edd2..12d5bb6 100644
--- a/tests/test_pagure_flask_api_ui_private_repo.py
+++ b/tests/test_pagure_flask_api_ui_private_repo.py
@@ -1489,7 +1489,7 @@ class PagurePrivateRepotest(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"comment": ["This field is required."]}
}
@@ -1629,7 +1629,7 @@ class PagurePrivateRepotest(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"comment": ["This field is required."]}
}
@@ -2033,7 +2033,7 @@ class PagurePrivateRepotest(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"issue_content": ["This field is required."],
@@ -2066,7 +2066,7 @@ class PagurePrivateRepotest(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {
"issue_content": ["This field is required."],
@@ -2687,7 +2687,7 @@ class PagurePrivateRepotest(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"status": ["Not a valid choice"]}
}
@@ -2826,7 +2826,7 @@ class PagurePrivateRepotest(tests.Modeltests):
self.assertDictEqual(
data,
{
- "error": "Invalid or incomplete input submited",
+ "error": "Invalid or incomplete input submitted",
"error_code": "EINVALIDREQ",
"errors": {"comment": ["This field is required."]}
}
diff --git a/tests/test_pagure_flask_ui_issues.py b/tests/test_pagure_flask_ui_issues.py
index dea98f4..27526c6 100644
--- a/tests/test_pagure_flask_ui_issues.py
+++ b/tests/test_pagure_flask_ui_issues.py
@@ -1651,7 +1651,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
'csrf_token': csrf_token,
'status': 'Closed',
'close_status': 'Fixed',
- 'comment': 'Woohoo a second comment !',
+ 'comment': 'Woohoo a second comment!',
}
output = self.app.post(
'/test/issue/1/update', data=data, follow_redirects=True)
@@ -1670,7 +1670,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
'\n No changes to edit',
output.data)
self.assertTrue(
- 'Woohoo a second comment !
' in output.data)
+ 'Woohoo a second comment!
' in output.data)
self.assertEqual(output.data.count('comment_body">'), 2)
self.assertTrue(
'Fixed '
@@ -1696,7 +1696,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
'href="/test/issue/1/edit" title="Edit this issue">',
output.data)
self.assertTrue(
- 'Woohoo a second comment !
' in output.data)
+ 'Woohoo a second comment!
' in output.data)
self.assertEqual(output.data.count('comment_body">'), 2)
self.assertTrue(
'Fixed '
@@ -1723,7 +1723,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
'\n No user "ralph" found',
output.data)
self.assertTrue(
- 'Woohoo a second comment !
' in output.data)
+ 'Woohoo a second comment!
' in output.data)
self.assertEqual(output.data.count('comment_body">'), 2)
self.assertTrue(
'Fixed '
@@ -1752,7 +1752,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
self.assertTrue(
'Woohoo a second comment !
' in output.data)
+ 'Woohoo a second comment!
' in output.data)
self.assertEqual(output.data.count('comment_body">'), 2)
self.assertTrue(
'Fixed '
@@ -1878,7 +1878,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
# Add new comment
data = {
'csrf_token': csrf_token,
- 'comment': 'Woohoo a second comment !',
+ 'comment': 'Woohoo a second comment!',
}
output = self.app.post(
'/test/issue/1/update', data=data, follow_redirects=True)
@@ -1894,7 +1894,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
'\n Comment added',
output.data)
self.assertTrue(
- 'Woohoo a second comment !
' in output.data)
+ 'Woohoo a second comment!
' in output.data)
self.assertEqual(output.data.count('comment_body">'), 2)
repo = pagure.get_authorized_project(self.session, 'test')
@@ -2931,7 +2931,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
# Add new comment
data = {
'csrf_token': csrf_token,
- 'comment': 'Woohoo a second comment !',
+ 'comment': 'Woohoo a second comment!',
}
output = self.app.post(
'/test/issue/1/update', data=data, follow_redirects=True)
@@ -2947,7 +2947,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
'\n Comment added',
output.data)
self.assertTrue(
- 'Woohoo a second comment !
' in output.data)
+ 'Woohoo a second comment!
' in output.data)
self.assertEqual(output.data.count('comment_body">'), 2)
repo = pagure.get_authorized_project(self.session, 'test')
@@ -2955,7 +2955,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
self.assertEqual(len(issue.comments), 1)
self.assertEqual(
issue.comments[0].comment,
- 'Woohoo a second comment !')
+ 'Woohoo a second comment!')
data = {
'csrf_token': csrf_token,
@@ -3558,7 +3558,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
'csrf_token': csrf_token,
'status': 'Closed',
'close_status': 'Fixed',
- 'comment': 'Woohoo a second comment !',
+ 'comment': 'Woohoo a second comment!',
}
output = self.app.post(
'/test/issue/1/update', data=data, follow_redirects=True)
@@ -3574,7 +3574,7 @@ class PagureFlaskIssuestests(tests.Modeltests):
'\n Comment added',
output.data)
self.assertTrue(
- 'Woohoo a second comment !
' in output.data)
+ 'Woohoo a second comment!
' in output.data)
self.assertEqual(output.data.count('comment_body">'), 2)
self.assertTrue(
'Fixed '