Merge pull request #139 from kogisin/kogisin/138-add-markdown-link-check

feat: add markdown links checker workflow
tendermint · Sep 27, 2021 · 9c24552 · 9c24552
2 parents 85846ba + d0b85e6
commit 9c24552
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 27 deletions.
diff --git a/.github/workflows/linkchecker.yml b/.github/workflows/linkchecker.yml
@@ -0,0 +1,19 @@
+name: Check Markdown links
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - develop
+  schedule: 
+    - cron: '* */24 * * *'
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: gaurav-nelson/github-action-markdown-link-check@1.0.13
+        with:
+          folder-path: "."
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,3 @@
+# Contributing
+
+TODO: add context
diff --git a/docs/Explanation/ADR/README.md b/docs/Explanation/ADR/README.md
@@ -36,4 +36,4 @@ When writing ADRs, follow the same best practices for writing RFCs. When writing
 
 ## ADR Table of Contents
 
-- [ADR XXX: Self Sovereign Identity](./adr-001-self-sovereign-identity.md)
+- [ADR 002: Documentation Structure](./adr-002-docs-structure.md)
diff --git a/docs/Explanation/README.md b/docs/Explanation/README.md
@@ -5,10 +5,7 @@ How to use the farming module Explanation Documentation.
 - [Explanation Documentation](#explanation-documentation)
   - [Introduction](#introduction)
   - [Layout](#layout)
-    - [Topics](#topics)
-    - [Presentations](#presentations)
     - [Architecture Decisions Records (ADRs)](#architecture-decisions-records-adrs)
-    - [Articles](#articles)
   - [Discussions](#discussions)
   - [Contributing](#contributing)
   - [Reference](#reference)
@@ -24,28 +21,12 @@ For further background information please see [the ADR relating to the documenta
 
 The scope and structure of the Explanation documentation follows this layout.
 
-### Topics
-
-Topics are discursive documents that explore some particular feature or theme.  For example, an article might investigate Decentralised Identity Documents or Self-Sovereign Identity.
-
-To contribute, create a folder in [topics](./topics) with a self-descriptive name. Add your content as needed.
-
-### Presentations
-
-The [Presentations](PRESENTATIONS.md) file describes and links to presentations about farming module at various events. Presentations also include YouTube videos,  podcasts, interviews, and so on. 
-
-
 ### Architecture Decisions Records (ADRs)
 
  ADRs are the mechanism for contributors to raise design proposals. In turn, the ADRs explain for subsequent contributors the rationale behind farming module design and implementation. For example, [ADR 002: Documentation Structure](./ADR/adr-002-docs-structure.md) explains why the farming module documentation structure was chosen. 
 
 See the Architecture Decision Records (ADR) [README](./ADR/README.md) file for more details about how to raise and propose an ADR.
 
-### Articles
-
-This folder contains all articles relating to farming module, includes papers, blog posts, and so on. For details, see [Articles README](articles/README.md).
-
-
 ## Discussions
 
 The explanation content includes articles, topics, and so on, and also includes discussion on relevant channels, including [Pull Requests](https://github.com/tendermint/farming/pulls) and [Issues](https://github.com/tendermint/farming/issues). Important Pull Requests are listed in this document.
@@ -57,7 +38,7 @@ Future: farming module currently doesn't have a Discord or Telegram Channel. Whe
 * All documentation is written following [Google Documentation Best Practice](https://google.github.io/styleguide/docguide/best_practices.html)
 * Autogenerate documentation from the code whenever possible.
 * Raise a PR for all documentation changes
-* Follow our [Code of Conduct](../CONTRIBUTING.md)
+* Follow our [Code of Conduct](../../CONTRIBUTING.md)
 
 ## Reference
 

diff --git a/docs/How-To/api/README.md b/docs/How-To/api/README.md
@@ -9,7 +9,7 @@ Description: A high-level overview of gRPC-gateway REST Routes in farming module
 
 ## gRPC-gateway REST Routes
 
-In order to test out the following REST routes, you need to set up a local node to query from. You can refer to this [localnet tutorial](./Tutorials/localnet) on how to build `farmingd` binary and bootstrap a local network in your local machine.
+In order to test out the following REST routes, you need to set up a local node to query from. You can refer to this [localnet tutorial](../../Tutorials/localnet) on how to build `farmingd` binary and bootstrap a local network in your local machine.
 
 - [Params](#Params)
 - [Plans](#Plans)
@@ -22,6 +22,7 @@ In order to test out the following REST routes, you need to set up a local node
 ### Params
 
 Query the values set as farming parameters
+<!-- markdown-link-check-disable-next-line -->
 http://localhost:1317/cosmos/farming/v1beta1/params
 
 ```json
@@ -43,6 +44,7 @@ http://localhost:1317/cosmos/farming/v1beta1/params
 
 Query all the farming plans exist in the network
 
+<!-- markdown-link-check-disable-next-line -->
 http://localhost:1317/cosmos/farming/v1beta1/plans
 
 ```json
@@ -91,6 +93,7 @@ http://localhost:1317/cosmos/farming/v1beta1/plans
 
 Query a particular plan 
 
+<!-- markdown-link-check-disable-next-line -->
 http://localhost:1317/cosmos/farming/v1beta1/plans/1
 
 ```json
@@ -133,6 +136,7 @@ http://localhost:1317/cosmos/farming/v1beta1/plans/1
 
 Query for all stakings by a farmer 
 
+<!-- markdown-link-check-disable-next-line -->
 http://localhost:1317/cosmos/farming/v1beta1/stakings/cosmos185fflsvwrz0cx46w6qada7mdy92m6kx4gqx0ny
 
 ```json
@@ -150,7 +154,8 @@ http://localhost:1317/cosmos/farming/v1beta1/stakings/cosmos185fflsvwrz0cx46w6qa
 
 Query for all stakings by a farmer with the given staking coin denom
 
-http://localhost:1317/cosmos/farming/v1beta1/stakings/cosmos185fflsvwrz0cx46w6qada7mdy92m6kx4gqx0ny?staking_coin_denom=poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4
+<!-- markdown-link-check-disable-next-line -->
+http://localhost:1317/cosmos/farming/v1beta1/stakings/cosmos185fflsvwrz0cx46w6qada7mdy92m6kx4gqx0ny?staking_coin_denom=poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 
 
 ```json
 {
@@ -168,7 +173,8 @@ http://localhost:1317/cosmos/farming/v1beta1/stakings/cosmos185fflsvwrz0cx46w6qa
 
 Query for total stakings by a staking coin denom 
 
-http://localhost:1317/cosmos/farming/v1beta1/total_stakings/poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4
+<!-- markdown-link-check-disable-next-line -->
+http://localhost:1317/cosmos/farming/v1beta1/total_stakings/poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 
 
 ```json
 {
@@ -180,6 +186,7 @@ http://localhost:1317/cosmos/farming/v1beta1/total_stakings/poolD35A0CC16EE598F9
 
 Query for all rewards by a farmer 
 
+<!-- markdown-link-check-disable-next-line -->
 http://localhost:1317/cosmos/farming/v1beta1/rewards/cosmos185fflsvwrz0cx46w6qada7mdy92m6kx4gqx0ny
 
 ```json
@@ -196,6 +203,7 @@ http://localhost:1317/cosmos/farming/v1beta1/rewards/cosmos185fflsvwrz0cx46w6qad
 
 Query for all rewards by a farmer with the staking coin denom
 
+<!-- markdown-link-check-disable-next-line -->
 http://localhost:1317/cosmos/farming/v1beta1/rewards/cosmos185fflsvwrz0cx46w6qada7mdy92m6kx4gqx0ny?staking_coin_denom=poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4
 
 ```json
@@ -213,6 +221,7 @@ http://localhost:1317/cosmos/farming/v1beta1/rewards/cosmos185fflsvwrz0cx46w6qad
 
 Query for the current epoch days
 
+<!-- markdown-link-check-disable-next-line -->
 http://localhost:1317/cosmos/farming/v1beta1/current_epoch_days
 
 ```json

diff --git a/docs/How-To/cli/README.md b/docs/How-To/cli/README.md
@@ -9,7 +9,7 @@ This document provides a high-level overview of how the command-line (CLI) inter
 
 ## Command-Line Interfaces
 
-In order to test out the following command-line interfaces, you need to set up a local node to either send transaction or query from. You can refer to this [localnet tutorial](./Tutorials/localnet) on how to build `farmingd` binary and bootstrap a local network in your local machine.
+In order to test out the following command-line interfaces, you need to set up a local node to either send transaction or query from. You can refer to this [localnet tutorial](../../Tutorials/localnet) on how to build `farmingd` binary and bootstrap a local network in your local machine.
 
 - [Transaction](#Transaction)
     * [MsgCreateFixedAmountPlan](#MsgCreateFixedAmountPlan)

diff --git a/docs/README.md b/docs/README.md
@@ -16,7 +16,6 @@ This approach outlines four specific use cases for documentation:
 * [Tutorials](./Tutorials/README.md)
 * [How-Tos](./How-To/README.md)
 * [Explanation](./Explanation/README.md)
-* [Reference](./Reference/README.md)
 
 For further background please see [the ADR relating to the documentation structure](./Explanation/ADR/adr-002-docs-structure.md). 
 

diff --git a/docs/Tutorials/demo/demo_2021_08_06.md b/docs/Tutorials/demo/demo_2021_08_06.md
@@ -15,7 +15,7 @@ Farming module is in active development by the Gravity DEX team in Tendermint. T
 - [Github Repo](https://github.com/tendermint/farming)
 - [Spec Docs](https://github.com/tendermint/farming/blob/master/x/farming/spec/01_concepts.md)
 - MVP branch uses [local-testing](https://github.com/tendermint/farming/tree/local-testing) 
-- Other useful resources are available in [docs](https://github.com/tendermint/farming/blob/master/docs/How-To/client.md) folder
+- Other useful resources are available in [docs](https://github.com/tendermint/farming/blob/master/docs) folder
 - [Swagger Docs v0.1.0](https://app.swaggerhub.com/apis-docs/gravity-devs/farming/0.1.0)
 
 ## Build