Bug 1746810 - markdown files containing 404 links
Summary: markdown files containing 404 links
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: GlusterFS
Classification: Community
Component: doc
Version: mainline
Hardware: All
OS: All
unspecified
medium
Target Milestone: ---
Assignee: Kshithij Iyer
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-08-29 10:09 UTC by Kshithij Iyer
Modified: 2019-09-05 04:57 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-09-05 04:57:26 UTC
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Gluster.org Gerrit 23343 0 None Merged [Doc] Fixing 404 links in markdown files. 2019-09-05 04:57:25 UTC

Description Kshithij Iyer 2019-08-29 10:09:44 UTC
Description of problem:
Seeing a lot of 404 links in the markdown files available across the project. 

$find . -name \*.md -exec markdown-link-check {} -v -q \;
FILE: ./extras/cliutils/README.md
[✖] https://github.com/aravindavk/glusterfs-restapi → Status: 404

ERROR: dead links found!

FILE: ./doc/developer-guide/commit-guidelines.md
[✖] mailto:name@example.com → Status: 400

ERROR: dead links found!

FILE: ./doc/developer-guide/gfapi-symbol-versions.md

FILE: ./doc/developer-guide/xlator-classification.md
[✖] TBD → Status: 400 Error: ENOENT: no such file or directory, access '/home/kiyer/upstream/glusterfs/doc/developer-guide/TBD'

ERROR: dead links found!

FILE: ./doc/developer-guide/translator-development.md
[✖] http://www.gluster.org/community/documentation/index.php/Translators → Status: 404

ERROR: dead links found!

FILE: ./doc/developer-guide/options-to-contribute.md
[✖] ./conding-standard.md → Status: 400 Error: ENOENT: no such file or directory, access '/home/kiyer/upstream/glusterfs/doc/developer-guide/conding-standard.md'

ERROR: dead links found!

FILE: ./doc/developer-guide/Using-Gluster-Test-Framework.md

FILE: ./doc/developer-guide/README.md
[✖] ./bd-xlator.md → Status: 400 Error: ENOENT: no such file or directory, access '/home/kiyer/upstream/glusterfs/doc/developer-guide/bd-xlator.md'
[✖] ./coredump-analysis.md → Status: 400 Error: ENOENT: no such file or directory, access '/home/kiyer/upstream/glusterfs/doc/developer-guide/coredump-analysis.md'

ERROR: dead links found!

FILE: ./doc/features/ganesha-ha.md

FILE: ./doc/debugging/statedump.md
[✖] https://github.com/gluster/glusterfs/blob/master/doc/data-structures/mem-pool.md → Status: 404

ERROR: dead links found!

FILE: ./doc/debugging/gfid-to-path.md
[✖] https://gist.github.com/semiosis/4392640 → Status: 404

ERROR: dead links found!

FILE: ./doc/README.md
[✖] http://docs.gluster.org/en/latest/Upgrade-Guide/README/ → Status: 404

ERROR: dead links found!

FILE: ./geo-replication/syncdaemon/README.md
[✖] http://python.net/crew/theller/ctypes/ → Status: 0 Error: ETIMEDOUT

ERROR: dead links found!

Version-Release number of selected component (if applicable):
Whatever is the latest upstream version

How reproducible:
Always

Steps to Reproduce:
1. Install markdown-link-checker using the below command:
# npm install --save markdown-link-check
2. Git clone glusterfs and run markdown_link check using the below command:
$find . -name \*.md -exec markdown-link-check {} -v -q \;

Actual results:
doc contain 404 links.

Expected results:
doc shouldn't contain 404 links.

Additional info:

Comment 1 Worker Ant 2019-09-02 13:21:12 UTC
REVIEW: https://review.gluster.org/23343 ([Doc]Fixing 404 links in markdown files.) posted (#1) for review on master by Kshithij Iyer

Comment 2 Worker Ant 2019-09-05 04:57:26 UTC
REVIEW: https://review.gluster.org/23343 ([Doc] Fixing 404 links in markdown files.) merged (#4) on master by Amar Tumballi


Note You need to log in before you can comment on or make changes to this bug.