From b0dbe11556c17ba6ea0b7d85b741bd4807c81c9c Mon Sep 17 00:00:00 2001 From: kshithijiyer Date: Mon, 2 Sep 2019 18:43:36 +0530 Subject: [Doc] Fixing 404 links in markdown files. Problem: While running markdown-link-checker it was observed that there were a large number of 404 links present in the documentation present in the form of markdown files in the project. This was casued due to the following reasons: 1. Repos being removed. 2. Typo in markdown links. 3. Restructring of directoires. Solution: Fixing all the 404 links present in the project. fixes: bz#1746810 Change-Id: I30de745f848fca2e9c92eb7493f74738f0890ed9 Signed-off-by: kshithijiyer --- doc/developer-guide/README.md | 5 ++--- doc/developer-guide/commit-guidelines.md | 2 +- doc/developer-guide/options-to-contribute.md | 2 +- doc/developer-guide/translator-development.md | 2 +- doc/developer-guide/xlator-classification.md | 2 +- 5 files changed, 6 insertions(+), 7 deletions(-) (limited to 'doc/developer-guide') diff --git a/doc/developer-guide/README.md b/doc/developer-guide/README.md index 1501eeb9207..aaf9c7476b0 100644 --- a/doc/developer-guide/README.md +++ b/doc/developer-guide/README.md @@ -51,11 +51,10 @@ Daemon Management Framework Translators ----------- -- [Block Device Tanslator](./bd-xlator.md) - [Performance/write-Behind Translator](./write-behind.md) - [Translator Development](./translator-development.md) - [Storage/posix Translator](./posix.md) -- [Compression translator](./network_compression.md) + Brick multiplex --------------- @@ -74,7 +73,7 @@ Testing/Debugging - [Using the Gluster Test Framework](./Using-Gluster-Test-Framework.md) - Step by step instructions for running the Gluster Test Framework -- [Coredump Analysis](./coredump-analysis.md) - Steps to analize coredumps generated by regression machines. +- [Coredump Analysis](../debugging/analyzing-regression-cores.md) - Steps to analize coredumps generated by regression machines. - [Identifying Resource Leaks](./identifying-resource-leaks.md) Release Process diff --git a/doc/developer-guide/commit-guidelines.md b/doc/developer-guide/commit-guidelines.md index 9b191dac178..38bbe525cbd 100644 --- a/doc/developer-guide/commit-guidelines.md +++ b/doc/developer-guide/commit-guidelines.md @@ -118,7 +118,7 @@ The 'bug' line can reference a bug in a few ways. Gerrit creates a link to the b **Updates: bz#1193929** -- use 'Updates: bz#NNNN' if the commit is only a partial fix and more work is needed. **Updates: #175** -- use 'Updates: #NNNN' if the commit is only a partial fix and more work is needed for the feature completion. -We encourage the use of Co-Authored-By: name in commit messages to indicate people who worked on a particular patch. It's a convention for recognizing multiple authors, and our projects would encourage the stats tools to observe it when collecting statistics. +We encourage the use of `Co-Authored-By: name ` in commit messages to indicate people who worked on a particular patch. It's a convention for recognizing multiple authors, and our projects would encourage the stats tools to observe it when collecting statistics. ### Summary of Git commit message structure diff --git a/doc/developer-guide/options-to-contribute.md b/doc/developer-guide/options-to-contribute.md index 5dd1895cb1c..3f0d84e7645 100644 --- a/doc/developer-guide/options-to-contribute.md +++ b/doc/developer-guide/options-to-contribute.md @@ -60,7 +60,7 @@ Reference: https://review.gluster.org/20925/ 5. Now, pick a `.h` file, and see if a structure is very large, and see -if re-aligning them as per [coding-standard](./conding-standard.md) gives any size benefit, +if re-aligning them as per [coding-standard](./coding-standard.md) gives any size benefit, if yes, go ahead and change it. Make sure you check all the structures in the file for similar pattern. diff --git a/doc/developer-guide/translator-development.md b/doc/developer-guide/translator-development.md index 8f67bb1cae9..f75935519f6 100644 --- a/doc/developer-guide/translator-development.md +++ b/doc/developer-guide/translator-development.md @@ -680,4 +680,4 @@ Original author's site: Gluster community site: - * [Translators](http://www.gluster.org/community/documentation/index.php/Translators) + * [Translators](https://docs.gluster.org/en/latest/Quick-Start-Guide/Architecture/#translators) diff --git a/doc/developer-guide/xlator-classification.md b/doc/developer-guide/xlator-classification.md index 36d924d0934..6073df9375f 100644 --- a/doc/developer-guide/xlator-classification.md +++ b/doc/developer-guide/xlator-classification.md @@ -23,7 +23,7 @@ This document is intended for the following community participants, - Existing xlator maintainers - Packaging and gluster management stack maintainers -For a more user facing understanding it is recommended to read section [tbd](TBD) +For a more user facing understanding it is recommended to read section (TBD) in the gluster documentation. ## Categories -- cgit