Bug 1746810

Summary: markdown files containing 404 links
Product: [Community] GlusterFS Reporter: Kshithij Iyer <kiyer>
Component: docAssignee: Kshithij Iyer <kiyer>
Status: CLOSED NEXTRELEASE QA Contact:
Severity: medium Docs Contact:
Priority: unspecified    
Version: mainlineCC: bugs
Target Milestone: ---Keywords: EasyFix
Target Release: ---   
Hardware: All   
OS: All   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-09-05 04:57:26 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

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:&#x6e;&#x61;&#x6d;&#x65;&#x40;&#101;&#x78;&#97;&#109;&#112;&#x6c;&#x65;&#46;&#x63;&#111;&#x6d; → 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