PR#107: Fix links in README - taskotron/resultsdb

taskotron / resultsdb

#107 Fix links in README

Closed 7 years ago by jskladan. Opened 7 years ago by elyscape.

Unknown source fix-readme-links into develop

Fix links in README

Eli Young • 7 years ago

81943ce

README.md

file modified

+3 -3

		`@@ -5,7 +5,7 @@`
		`## What is ResultsDB`

		`ResultsDB is a results store engine for (not only) Fedora QA tools. The API`
		`- documentation can be found at <http://docs.resultsdb20.apiary.io/>.`
		`+ documentation can be found at http://docs.resultsdb20.apiary.io/.`

		`## Repositories`

		`@@ -41,8 +41,8 @@`

		`$ DEV=true python runapp.py`

		`- The server is now running with a very simple frontend at <http://localhost:5001>.`
		`- API calls can be sent to <http://localhost:5001/api/v2.0>. All data is stored`
		`+ The server is now running with a very simple frontend at http://localhost:5001.`
		`+ API calls can be sent to http://localhost:5001/api/v2.0. All data is stored`
		inside `/var/tmp/resultsdb_db.sqlite`.

		`## Adjusting configuration`

no initial comment

jskladan commented 7 years ago

I don't really understand the change. Those are perfectly valid Markdown links.
Refer to the docs for syntax: https://daringfireball.net/projects/markdown/syntax#autolink referenced in Pagure's docs: https://docs.pagure.org/pagure/usage/markdown.html

If there's a problem with these, a bug/PR should be proposed for either Pagure or the underlying library (python-markdown according to Pagure's docs).

Pull-Request has been closed by jskladan

7 years ago

elyscape commented 7 years ago

Looks like you're right! The reason for my change is that the links are incorrectly being treated as relative links. If you click on the API documentation link in the README, it sends you to https://pagure.io/taskotron/<http://docs.resultsdb20.apiary.io/>, which is obviously wrong.

elyscape commented 7 years ago

Looks like this was raised in pagure#2906 and fixed in version 4.0.0, which isn't currently running here.

jskladan commented 7 years ago

:thumbsup: