*.md: Improvements for markdownlint

Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com>
rastislavs · Apr 2, 2018 · 008f340 · 008f340
1 parent 79d264b
commit 008f340
Show file tree

Hide file tree

Showing 25 changed files with 892 additions and 687 deletions.
diff --git a/README.md b/README.md
@@ -26,28 +26,30 @@ $ cd $GOPATH/src/github.com/osrg/gobgp && dep ensure
 ## Documentation
 
 ### Using GoBGP
- * [Getting Started](https://github.com/osrg/gobgp/blob/master/docs/sources/getting-started.md)
- * CLI
-   * [Typical operation examples](https://github.com/osrg/gobgp/blob/master/docs/sources/cli-operations.md)
-   * [Complete syntax](https://github.com/osrg/gobgp/blob/master/docs/sources/cli-command-syntax.md)
- * [Route Server](https://github.com/osrg/gobgp/blob/master/docs/sources/route-server.md)
- * [Route Reflector](https://github.com/osrg/gobgp/blob/master/docs/sources/route-reflector.md)
- * [Policy](https://github.com/osrg/gobgp/blob/master/docs/sources/policy.md)
- * [FIB manipulation](https://github.com/osrg/gobgp/blob/master/docs/sources/zebra.md)
- * [MRT](https://github.com/osrg/gobgp/blob/master/docs/sources/mrt.md)
- * [BMP](https://github.com/osrg/gobgp/blob/master/docs/sources/bmp.md)
- * [EVPN](https://github.com/osrg/gobgp/blob/master/docs/sources/evpn.md)
- * [Flowspec](https://github.com/osrg/gobgp/blob/master/docs/sources/flowspec.md)
- * [RPKI](https://github.com/osrg/gobgp/blob/master/docs/sources/rpki.md)
- * [Managing GoBGP with your favorite language with GRPC](https://github.com/osrg/gobgp/blob/master/docs/sources/grpc-client.md)
- * [Using GoBGP as a Go Native BGP library](https://github.com/osrg/gobgp/blob/master/docs/sources/lib.md)
- * [Graceful Restart](https://github.com/osrg/gobgp/blob/master/docs/sources/graceful-restart.md)
- * Data Center Networking
-   * [Unnumbered BGP](https://github.com/osrg/gobgp/blob/master/docs/sources/unnumbered-bgp.md)
+
+- [Getting Started](docs/sources/getting-started.md)
+- CLI
+  - [Typical operation examples](docs/sources/cli-operations.md)
+  - [Complete syntax](docs/sources/cli-command-syntax.md)
+- [Route Server](docs/sources/route-server.md)
+- [Route Reflector](docs/sources/route-reflector.md)
+- [Policy](docs/sources/policy.md)
+- [FIB manipulation](docs/sources/zebra.md)
+- [MRT](docs/sources/mrt.md)
+- [BMP](docs/sources/bmp.md)
+- [EVPN](docs/sources/evpn.md)
+- [Flowspec](docs/sources/flowspec.md)
+- [RPKI](docs/sources/rpki.md)
+- [Managing GoBGP with your favorite language with gRPC](docs/sources/grpc-client.md)
+- [Using GoBGP as a Go Native BGP library](docs/sources/lib.md)
+- [Graceful Restart](docs/sources/graceful-restart.md)
+- Data Center Networking
+  - [Unnumbered BGP](docs/sources/unnumbered-bgp.md)
 
 ### Externals
- * [Tutorial: Using GoBGP as an IXP connecting router](http://www.slideshare.net/shusugimoto1986/tutorial-using-gobgp-as-an-ixp-connecting-router)
-
+
+- [Tutorial: Using GoBGP as an IXP connecting router](http://www.slideshare.net/shusugimoto1986/tutorial-using-gobgp-as-an-ixp-connecting-router)
+
 ## Community, discussion and support
 
 We have the [Slack](https://slackin-gobgp.mybluemix.net/) and [mailing

diff --git a/docs/sources/add-paths.md b/docs/sources/add-paths.md
@@ -8,16 +8,16 @@ the "Advertise N Paths" mode described in
 
 ## Prerequisites
 
-Assumed that you finished [Getting Started](https://github.com/osrg/gobgp/blob/master/docs/sources/getting-started.md).
+Assumed that you finished [Getting Started](getting-started.md).
 
 ## Contents
 
-- [Configuration](#section0)
-- [Verification](#section1)
-    - [Example Topology and Configuration](#section1.1)
-    - [Advertise Multiple Paths](#section1.2)
+- [Configuration](#configuration)
+- [Verification](#verification)
+  - [Example Topology and Configuration](#example-topology-and-configuration)
+  - [Advertise Multiple Paths](#advertise-multiple-paths)
 
-## <a name="section0"> Configuration
+## Configuration
 
 In order to advertise multiple paths to the specific neighbors, you need to
 configure `[neighbors.add-paths.config]` section for each neighbor.
@@ -54,14 +54,14 @@ unicast family.
       send-max = 8
 ```
 
-## <a name="section1"> Verification
+## Verification
 
-### <a name="section1.1"> Example Topology and Configuration
+### Example Topology and Configuration
 
 To test BGP Additional Paths features, this page supposes the following
 topology.
 
-```
+```text
 +----------+                    +----------+          +----------+
 | r1       |                    | r2       |          | r3       |
 | AS 65001 |  ADD-PATH enabled  | AS 65002 |          | AS 65003 |
@@ -131,14 +131,14 @@ Configuration on r2:
       afi-safi-name = "ipv4-unicast"
 ```
 
-### <a name="section1.2"> Advertise Multiple Paths
+### Advertise Multiple Paths
 
 Start GoBGP on r1, r2, r3 and r4, and confirm the establishment of each BGP
 session.
 
 e.g.:
 
-```
+```bash
 r1> gobgpd -f gobgpd.toml
 {"level":"info","msg":"gobgpd started","time":"YYYY-MM-DDTHH:mm:ss+09:00"}
 {"Topic":"Config","level":"info","msg":"Finished reading the config file","time":""YYYY-MM-DDTHH:mm:ss+09:00"}
@@ -149,19 +149,19 @@ r1> gobgpd -f gobgpd.toml
 
 Advertise a prefix "192.168.1.0/24" on r3 and r4.
 
-```
+```bash
 r3> gobgp global rib -a ipv4 add 192.168.1.0/24
 ```
 
-```
+```bash
 r4> gobgp global rib -a ipv4 add 192.168.1.0/24
 ```
 
 Then confirm 2 paths (from r3 and r4) are advertised to r1 from r2.
 In the following output shows the path with AS_PATH 65002 65003 (r3->r2->r1)
 and the path with AS_PATH 65002 65004 (r4->r2->r1).
 
-```
+```bash
 r1> gobgp global rib -a ipv4
    Network              Next Hop             AS_PATH              Age        Attrs
 *> 192.168.1.0/24       10.0.0.2             65002 65003          HH:mm:ss   [{Origin: ?}]

diff --git a/docs/sources/bmp.md b/docs/sources/bmp.md
@@ -4,15 +4,16 @@ GoBGP supports [BGP Monitoring Protocol (RFC 7854)](https://tools.ietf.org/html/
 
 ## Prerequisites
 
-Assume you finished [Getting Started](https://github.com/osrg/gobgp/blob/master/docs/sources/getting-started.md).
+Assume you finished [Getting Started](getting-started.md).
 
 ## Contents
-- [Configuration](#config)
-- [Verification](#verify)
 
-## <a name="config"> Configuration
+- [Configuration](#configuration)
+- [Verification](#verification)
 
-Add `[bmp-servers]` session to enable BMP. 
+## Configuration
+
+Add `[bmp-servers]` session to enable BMP.
 
 ```toml
 [global.config]
@@ -26,6 +27,7 @@ Add `[bmp-servers]` session to enable BMP.
 ```
 
 The supported route monitoring policy types are:
+
 - pre-policy (Default)
 - post-policy
 - both (Obsoleted)
@@ -75,13 +77,14 @@ Please note this option is mainly for debugging purpose.
     route-mirroring-enabled = true
 ```
 
-## <a name="verify"> Verification
+## Verification
 
 Let's check if BMP works with a bmp server. GoBGP also supports BMP server (currently, just shows received BMP messages in the json format).
 
 ```bash
 $ go get github.com/osrg/gobgp/gobmpd
 $ gobmpd
+...(snip)...
 ```
 
 Once the BMP server accepts a connection from gobgpd, then you see