PR#1719: Provide link for pagure documentation - pagure

pagure

#1719 Provide link for pagure documentation

Closed 7 years ago by pingou. Opened 7 years ago by rahulbajaj.

rahulbajaj/pagure DocGuide into master

Provide link for pagure documentation

rahul Bajaj • 7 years ago

d4ed15b

pagure/docs_server.py

file modified

+8 -2

		`@@ -139,7 +139,10 @@`
		`if not repo_obj.is_empty:`
		`commit = repo_obj[repo_obj.head.target]`
		`else:`
		`- flask.abort(404, 'No content found is the repository')`
		`+ flask.abort(404, 'No content found in the repository, '`
		`+ 'you may want to read the '`
		`+ '<a href="https://docs.pagure.org/pagure/usage/using_doc.html">'`
		`+ 'Using the doc repository of your project</a> documentation.')`
		`branchname = 'master'`

		`content = None`
		`@@ -169,7 +172,10 @@`

		`if not content:`
		`if not tree or not len(tree):`
		`- flask.abort(404, 'No content found is the repository')`
		`+ flask.abort(404, 'No content found in the repository, '`
		`+ 'you may want to read the '`
		`+ '<a href="https://docs.pagure.org/pagure/usage/using_doc.html">'`
		`+ 'Using the doc repository of your project</a> documentation.')`
		`html = '<li>'`
		`for el in tree:`
		`name = el.name`

tests/test_pagure_flask_docs.py

file modified

		`@@ -163,6 +163,13 @@`

		`output = self.app.get('/test/docs')`
		`self.assertEqual(output.status_code, 404)`
		`+ self.assertIn(`
		`+ '<p>No content found in the repository, '`
		`+ 'you may want to read the '`
		`+ '<a href="https://docs.pagure.org/pagure/usage/using_doc.html">'`
		`+ 'Using the doc repository of your project</a> documentation.</p>',`
		`+ output.data`
		`+ )`

		`output = self.app.get('/test/sources')`
		`self.assertEqual(output.status_code, 200)`

rahulbajaj commented 7 years ago

Apparently, the end user being new to pagure is unable to
configure his/her project documentation and does not know where
to look for it.
This patch provides a link that directs the user to pagure documentation
that shall help the users to configure thier projects documents.

Fixes: https://pagure.io/pagure/issue/1562

pingou commented on line 6 of pagure/docs_server.py 7 years ago

Two small remarks:

a) Could you make the lines shorter?
b) Since you are within () there is no need for the \. You can simply do:

flask.abort(404, 'No content found in the repository, '
                  'to know more about the documentation please visit '
                  '<a href="....">....</a>'
)

Or something like this :)

pingou commented 7 years ago

Another thing we could do is adding a small test for this feature, maybe something like:

diff --git a/ tests/test_pagure_flask_docs.py b/ tests/test_pagure_flask_docs.py
index a954aec..a6a2a42 100644
--- a/tests/test_pagure_flask_docs.py  
+++ b/tests/test_pagure_flask_docs.py  
@@ -163,6 +163,12 @@ class PagureFlaskDocstests(tests.Modeltests):

         output = self.app.get('/test/docs')
         self.assertEqual(output.status_code, 404)
+        self.assertIn(
+            '<p>No content found in the repository, to know more about the '
+            'documentation please visit '
+            'https://docs.pagure.org/pagure/usage/using_doc.html</p>',
+            output.data
+        )

         output = self.app.get('/test/sources')
         self.assertEqual(output.status_code, 200)

To adjust based on the change you make :)

rebased

7 years ago