Merge pull request #5427 from input-output-hk/mgalazyn/doc/fix-links

Fix broken links in docs

Author: carbolymer

mlc_config.json renamed to .github/mlc_config.json

@@ -12,3 +12,4 @@ jobs:
     - uses: gaurav-nelson/github-action-markdown-link-check@v1
       with:
         use-quiet-mode: yes
+        config-file: '.github/mlc_config.json'

.github/workflows/markdown-links-ci-check.yml

@@ -6,8 +6,7 @@
 # NB - The last matching pattern takes precedence
 
 # Technical writers
-# /doc folder and README.* needs to be owned by @docs-access
-doc/                                                          @input-output-hk/docs-access @input-output-hk/core-tech
+# README.* needs to be owned by @docs-access
 README.*                                                      @input-output-hk/docs-access @input-output-hk/core-tech
 CONTRIBUTING.rst                                              @input-output-hk/docs-access @input-output-hk/core-tech
 

CODEOWNERS

@@ -4,7 +4,7 @@ Contributing to the ``cardano-node`` project
 
 The ``cardano-node`` development is primarily based on the Nix infrastructure (https://nixos.org/ ), which enables packaging, CI, development environments and deployments.
 
-On how to set up Nix for ``cardano-node`` development, please see `Building Cardano Node with nix <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/getting-started/building-the-node-using-nix.md>`_.
+On how to set up Nix for ``cardano-node`` development, please see `Building Cardano Node with nix <https://github.com/input-output-hk/cardano-node-wiki/wiki/building-the-node-using-nix>`_.
 
 
 Roles and Responsibilities
@@ -30,7 +30,7 @@ Testing
 
 ``cardano-node`` is essentially a container which implements several components such networking, consensus, and storage. These components have individual test coverage. The node goes through integration and release testing by Devops/QA while automated CLI tests are ongoing alongside development.
 
-Developers on ``cardano-node`` can `launch their own testnets <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/getting-started/launching-a-testnet.md>`_ or `run the chairman tests <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/getting-started/running-chairman-tests.md>`_ locally.
+Developers on ``cardano-node`` can `launch their own testnets <https://github.com/input-output-hk/cardano-node-wiki/wiki/launching-a-testnet>`_ or `run the chairman tests <https://github.com/input-output-hk/cardano-node-wiki/wiki/running-chairman-tests>`_ locally.
 
 Debugging
 ====

CONTRIBUTING.rst

@@ -53,7 +53,7 @@ Documentation for building the node can be found `here <https://docs.cardano.org
 Executables
 ===========
 
-You can download the hydra binaries of ``cardano-node`` and ``cardano-cli`` from the [release notes](https://github.com/input-output-hk/cardano-node/releases)
+You can download the hydra binaries of ``cardano-node`` and ``cardano-cli`` from the `release notes <https://github.com/input-output-hk/cardano-node/releases>`_
 
 
 Running the node on Windows
@@ -118,7 +118,7 @@ The general synopsis is as follows:
 
 * ``--start-as-non-producing-node`` -  Optional flag to disable block production on node
   start. If credentials flags are passed the node will start block producing, however with
-  this flag the node will only start block producing on SIGHUP (see `here <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/reference/dynamic-block-forging.md>` for more details)
+  this flag the node will only start block producing on SIGHUP (see `here <https://github.com/input-output-hk/cardano-node-wiki/wiki/dynamic-block-forging>`_ for more details)
 
 * ``--socket-path`` - Path to the socket file.
 
@@ -213,7 +213,7 @@ The Byron genesis generation operations will create a directory that contains:
 * ``poor-keys.*.key``:
   Non-delegate private keys with genesis UTxO. Affected by: ``--n-poor-addresses``, ``--total-balance``.
 
-More details on the Byron Genesis ``JSON`` file can be found in ``https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/reference/byron-genesis.md``
+More details on the Byron Genesis ``JSON`` file can be found in ``https://github.com/input-output-hk/cardano-node-wiki/wiki/byron-genesis``
 
  Byron genesis delegation and related concepts are described in detail in:
 
@@ -434,11 +434,11 @@ To help you get started, see:
 
 - `Ledger explanations: native tokens <https://cardano-ledger.readthedocs.io/en/latest/>`_. Covers explainers about assets, tokens, token bundles, minting policies, comparison to ERC20, and minimum ada value requirements.
 
-- `A tutorial on how to get started with native tokens <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/reference/native-tokens/02-getting-started.md>`_. Explains how to create new currencies and assets, submit and send transactions containing multi-asset tokens, send and receive token bundles, manage your addresses and values.
+- `A tutorial on how to get started with native tokens <https://github.com/input-output-hk/cardano-node-wiki/wiki/02-getting-started>`_. Explains how to create new currencies and assets, submit and send transactions containing multi-asset tokens, send and receive token bundles, manage your addresses and values.
 
-- `Native tokens exercises <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/reference/native-tokens/03-exercises.md>`_
+- `Native tokens exercises <https://github.com/input-output-hk/cardano-node-wiki/wiki/03-exercises>`_
 
-To start, please ensure that you are familiar with setting up and operating the `Cardano node <https://github.com/input-output-hk/cardano-node>`_. Alternatively, see instructions on how to `start your node <https://github.com/input-output-hk/cardano-node-wiki/blob/main/doc/stake-pool-operations/2_start_your_nodes.md>`_ to submit the commands. You will not need to set up and start a full block producing node ('stake pool'), just a much simpler relay node. This node will need to connect to a Cardano network that is capable of processing native tokens (e.g., the native token pre-production environment (PPE), or the Cardano mainnet).
+To start, please ensure that you are familiar with setting up and operating the `Cardano node <https://github.com/input-output-hk/cardano-node>`_. Alternatively, see instructions on how to `start your node <https://github.com/input-output-hk/cardano-node-wiki/wiki/2_start_your_nodes>`_ to submit the commands. You will not need to set up and start a full block producing node ('stake pool'), just a much simpler relay node. This node will need to connect to a Cardano network that is capable of processing native tokens (e.g., the native token pre-production environment (PPE), or the Cardano mainnet).
 
 ****
 API Documentation
@@ -461,8 +461,8 @@ Please note that you may need to use any ``source-repository-package`` stanzas d
 Style guide
 ****
 
-The `style guide <https://github.com/input-output-hk/cardano-node-wiki/wiki/Style-guide>` for can be found
-on the `cardano-node repository's wiki <https://github.com/input-output-hk/cardano-node-wiki/wiki>`.
+The `style guide <https://github.com/input-output-hk/cardano-node-wiki/wiki/Style-guide>`_ for can be found
+on the `cardano-node repository's wiki <https://github.com/input-output-hk/cardano-node-wiki/wiki>`_.
 
 ****
 Troubleshooting ``cardano-node`` issues

README.rst

@@ -96,7 +96,7 @@ None
   (input-output-hk/ouroboros-network#4357).
 
 [#4563]: https://github.com/input-output-hk/cardano-node/issues/4563
-[understanding-config-files]: https://github.com/input-output-hk/cardano-node/blob/master/doc/getting-started/understanding-config-files.md
+[understanding-config-files]: https://github.com/input-output-hk/cardano-node-wiki/wiki/understanding-config-files
 
 ## 1.35.5 -- November 2022
 

cardano-node/ChangeLog.md

@@ -1 +1 @@
-For information on how to use this package, see [Launching a Testnet](../doc/getting-started/launching-a-testnet.md)
+For information on how to use this package, see [Launching a Testnet](https://github.com/input-output-hk/cardano-node-wiki/wiki/launching-a-testnet)

cardano-testnet/README.md

@@ -1,7 +1,7 @@
 
 ## Build Cardano Node + Image
 
-https://github.com/input-output-hk/cardano-node/blob/master/doc/getting-started/building-the-node-using-nix.md/
+https://github.com/input-output-hk/cardano-node-wiki/wiki/building-the-node-using-nix
 
 ```
 # Build + Install the cardano node

nix/docker/README.md

@@ -44,7 +44,7 @@
 `trace-dispatcher` is an attempt to enable design and implementation of simple, efficient __tracing systems__, one that has a reduced footprint in the executed program, has a more pleasant API, and provides self-documenting features.
 
 For a quick start into new tracing see the document
-[New Tracing Quickstart](https://github.com/input-output-hk/cardano-node/blob/master/doc/New%20Tracing%20Quickstart.md)
+[New Tracing Quickstart](https://github.com/input-output-hk/cardano-node-wiki/wiki/New-Tracing-Quickstart)
 
 
 ## Design decisions
@@ -762,7 +762,7 @@ runTraceDocumentationCmd
   -> IO ()
 ```
 
-A periodically generated documentation of the tracers can be found in the cardano-node repository in the path `cardano-node/doc/new-tracing/tracers_doc_generated.md`
+A periodically generated documentation of the tracers can be found in the cardano-node-wiki repository in the path `https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/new-tracing/tracers_doc_generated.md`
 
 
 # Appendix
@@ -772,11 +772,11 @@ A periodically generated documentation of the tracers can be found in the cardan
 This is a document which is regenerated periodically and documents all trace-messages,  metrics and data-points in cardano-node. It as well displays the handling of these
 messages with the current default configuration:
 
-[Generated Cardano Trace Documentation](https://github.com/input-output-hk/cardano-node/blob/master/doc/new-tracing/tracers_doc_generated.md)
+[Generated Cardano Trace Documentation](https://github.com/input-output-hk/cardano-node-wiki/wiki/tracers_doc_generated)
 
 For a quick start into new tracing see the document:
 
-[New Tracing Quickstart](https://github.com/input-output-hk/cardano-node/blob/master/doc/New%20Tracing%20Quickstart.md)
+[New Tracing Quickstart](https://github.com/input-output-hk/cardano-node-wiki/wiki/New-Tracing-Quickstart)
 
 This document describes a separate service for logging and monitoring Cardano nodes: