Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] fix: broken links #764

Merged
merged 3 commits into from
Apr 14, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _symbol
Submodule _symbol updated 44 files
+10 −0 .github/dependabot.yaml
+3 −1 README.md
+1 −1 catbuffer/parser/requirements.txt
+6 −0 client/catapult/CHANGELOG.md
+9 −2 client/catapult/Jenkinsfile
+1 −1 client/catapult/docs/BUILD-manual.md
+25 −0 client/catapult/scripts/ci/build.sh
+15 −0 client/catapult/scripts/ci/setup_test.sh
+25 −1 client/catapult/scripts/ci/test.sh
+1 −1 client/catapult/src/catapult/version/version_inc.h
+130 −147 client/rest/package-lock.json
+3 −3 client/rest/package.json
+22 −12 codecov.yaml
+1 −0 jenkins/catapult/BasicBuildManager.py
+1 −1 jenkins/catapult/baseImageDockerfileGenerator.py
+3 −2 jenkins/catapult/configuration.py
+3 −0 jenkins/catapult/configurations/gcc-10-code-coverage.yaml
+7 −0 jenkins/catapult/jenkins/catapult-client-build-catapult-project-daily.groovy
+34 −4 jenkins/catapult/jenkins/catapult-client-build-catapult-project.groovy
+5 −3 jenkins/catapult/jenkins/catapult-client-prepare-base-image.groovy
+8 −7 jenkins/catapult/jenkins/catapult-client-release-build.groovy
+8 −3 jenkins/catapult/runDockerBuild.py
+24 −20 jenkins/catapult/runDockerBuildInnerBuild.py
+10 −6 jenkins/catapult/runDockerTestsInnerLint.py
+15 −10 jenkins/catapult/runDockerTestsInnerTest.py
+1 −1 jenkins/catapult/server.version.yaml
+1 −1 jenkins/catapult/templates/RunLint.yaml
+2 −1 jenkins/catapult/templates/RunTest.yaml
+22 −0 jenkins/docker/cpp.Dockerfile
+2 −2 jenkins/docker/javascript.Dockerfile
+12 −7 jenkins/shared-library/vars/defaultCiPipeline.groovy
+9 −0 sdk/javascript/CHANGELOG.md
+90 −0 sdk/javascript/README.md
+1 −1 sdk/javascript/generator/requirements.txt
+53 −70 sdk/javascript/package-lock.json
+7 −7 sdk/javascript/package.json
+50 −0 sdk/javascript/src/index.js
+2 −2 sdk/javascript/src/nem/TransactionFactory.js
+1 −1 sdk/javascript/src/symbol/TransactionFactory.js
+1 −1 sdk/javascript/test/nem/TransactionFactory_spec.js
+1 −1 sdk/javascript/test/symbol/TransactionFactory_spec.js
+10 −0 sdk/python/CHANGELOG.md
+1 −1 sdk/python/pyproject.toml
+2 −2 sdk/python/requirements.txt
7 changes: 7 additions & 0 deletions scripts/ci/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,10 @@
set -ex

make gettext

echo "Building docs..."
make alldocs

echo "Linking Check..."
make linkcheck

6 changes: 0 additions & 6 deletions scripts/ci/deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

set -ex

echo "Building docs..."
make alldocs

echo "Linking Check..."
make linkcheck

echo "Publishing..."
git remote add github "https://${GITHUB_ACCESS_TOKEN}@github.com/symbol/symbol-docs.git" > /dev/null 2>&1

Expand Down
26 changes: 13 additions & 13 deletions source/compatibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ APIs
:header: "Milestone", "OpenAPI", "Rest", "SDK TS", "SDK Java"
:delim: ;

`v1.0.1.0 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-1010---26-may-2021>`_; v1.0.0; v2.3.6; v1.0.1; v1.0.1
`v1.0.0.0 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-1000---12-mar-2021>`_; v1.0.0; v2.3.5; v1.0.0; v1.0.0
`v0.10.0.7 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-01007---15-feb-2021>`_; v0.11.2; v2.3.3; v0.23.2; v0.23.1
`v0.10.0.6 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-01006---02-feb-2021>`_; v0.11.2; v2.3.2; v0.23.1; v0.23.1
`v0.10.0.5 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-01005---14-jan-2021>`_; v0.11.1; v2.3.0; v0.23.0; v0.23.0
`v0.10.0.4 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-01004---04-dec-2020>`_; v0.10.5; v2.2.0; v0.22.2; v0.22.2
`v0.10.0.3 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-01003---25-sep-2020>`_; v0.10.0; v2.1.0; v0.21.0; v0.21.0
`v0.9.6.4 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-0964---27-jul-2020>`_; v0.9.6; v1.2.1; v0.20.7; v0.20.3
`v0.9.6.3 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-0963---10-jul-2020>`_; v0.9.4; v1.1.3; v0.20.6; v0.20.2
`v0.9.5.1 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-0951---22-may-2020>`_; v0.8.11; v1.0.20.50; v0.19.2; v0.19.0
`v0.9.4.1 <https://github.com/symbol/catapult-client/blob/main/CHANGELOG.md#user-content-0941---23-april-2020>`_; v0.8.11; v1.0.20.31; v0.18.0; v0.17.2
`v1.0.1.0 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-1010---26-may-2021>`_; v1.0.0; v2.3.6; v1.0.1; v1.0.1
`v1.0.0.0 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-1000---12-mar-2021>`_; v1.0.0; v2.3.5; v1.0.0; v1.0.0
`v0.10.0.7 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-01007---15-feb-2021>`_; v0.11.2; v2.3.3; v0.23.2; v0.23.1
`v0.10.0.6 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-01006---02-feb-2021>`_; v0.11.2; v2.3.2; v0.23.1; v0.23.1
`v0.10.0.5 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-01005---14-jan-2021>`_; v0.11.1; v2.3.0; v0.23.0; v0.23.0
`v0.10.0.4 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-01004---04-dec-2020>`_; v0.10.5; v2.2.0; v0.22.2; v0.22.2
`v0.10.0.3 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-01003---25-sep-2020>`_; v0.10.0; v2.1.0; v0.21.0; v0.21.0
`v0.9.6.4 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-0964---27-jul-2020>`_; v0.9.6; v1.2.1; v0.20.7; v0.20.3
`v0.9.6.3 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-0963---10-jul-2020>`_; v0.9.4; v1.1.3; v0.20.6; v0.20.2
`v0.9.5.1 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-0951---22-may-2020>`_; v0.8.11; v1.0.20.50; v0.19.2; v0.19.0
`v0.9.4.1 <https://github.com/symbol/symbol/blob/main/client/catapult/CHANGELOG.md#user-content-0941---23-april-2020>`_; v0.8.11; v1.0.20.31; v0.18.0; v0.17.2

- `OpenAPI CHANGELOG <https://github.com/symbol/symbol-openapi/blob/main/CHANGELOG.md>`_
- `REST CHANGELOG <https://github.com/symbol/catapult-rest/blob/main/CHANGELOG.md>`_
- `REST CHANGELOG <https://github.com/symbol/symbol/blob/main/client/rest/CHANGELOG.md>`_
- `SDK TS CHANGELOG <https://github.com/symbol/symbol-sdk-typescript-javascript/blob/main/CHANGELOG.md>`_
- `SDK Java CHANGELOG <https://github.com/symbol/symbol-sdk-java/blob/main/CHANGELOG.md>`_

Expand All @@ -51,4 +51,4 @@ Tools

- `Desktop Wallet CHANGELOG <https://github.com/symbol/symbol-desktop-wallet/blob/main/CHANGELOG.md>`_
- `symbol-cli CHANGELOG <https://github.com/symbol/symbol-cli/blob/main/CHANGELOG.md>`_
- `symbol-bootstrap CHANGELOG <https://github.com/symbol/symbol-bootstrap/blob/main/CHANGELOG.md>`_
- `symbol-bootstrap CHANGELOG <https://github.com/fboucquez/symbol-bootstrap/blob/main/CHANGELOG.md>`_
2 changes: 1 addition & 1 deletion source/concepts/inflation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The previous configuration example inflates 500 currency mosaics per block from
Between the blocks 100 and 1250, the currency mosaic supply increases by 400 units per block.
Starting at height 1250, new blocks will not trigger the creation of mosaics.

The `network configuration <https://github.com/symbol/catapult-client/blob/main/resources/config-network.properties>`_ also describes the initial and **maximum supply** of the native currency mosaic. The maximum supply takes into account the inflation generated per-block.
The `network configuration <https://github.com/symbol/symbol/blob/main/client/catapult/resources/config-network.properties>`_ also describes the initial and **maximum supply** of the native currency mosaic. The maximum supply takes into account the inflation generated per-block.

.. code-block:: bash

Expand Down
2 changes: 1 addition & 1 deletion source/concepts/transaction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ All transactions should define a deadline and a max_fee:

* ``max_fee``: The maximum amount of network currency that the sender of the transaction is willing to pay to get the transaction accepted. :doc:`The next documentation <fees>` shows you how to set the optimal max_fee value.

.. note:: The `catbuffer schemas <https://github.com/symbol/catbuffer-schemas>`_ repository defines how each transaction type should be serialized. In combination with the `catbuffer-generators <https://github.com/symbol/catbuffer-generators>`_ project, developers can generate builder classes for a given set of programming languages.
.. note:: The `catbuffer schemas <https://github.com/symbol/symbol/tree/main/catbuffer/schemas>`_ repository defines how each transaction type should be serialized. In combination with the catbuffer generators, developers can generate builder classes for a given set of programming languages.

We recommend using the :doc:`SDK <../sdk>` to define new transactions.

Expand Down
10 changes: 7 additions & 3 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ def setup(app):

.. |symbol-bootstrap| raw:: html

<a href="https://github.com/symbol/symbol-bootstrap" target="_blank">Symbol Bootstrap</a>
<a href="https://github.com/fboucquez/symbol-bootstrap" target="_blank">Symbol Bootstrap</a>

.. |techref| raw:: html

Expand Down Expand Up @@ -354,6 +354,10 @@ def setup(app):
r'https://hackmd.io/.*', # You need to login to access some of the pages
r'https://arxiv.org/.*', # Sometimes returns 403 on Travis (rate limit?)
r'https://www.researchgate.net/.*', # Started returning 403 on Travis
r'https://symbolblog.com/.*', # Returning 403
r'https://docs.github.com/.*', # GitHub is now returning 403
r'https://help.github.com/.*', # GitHub is now returning 403
r'https://github.com/fboucquez/symbol-bootstrap#command-topics', # Returning Anchor 'command-topics' not found
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd really prefer that we do not overpopulate this list... this is weakening the link check :/
I think the right anchor in this case is:
https://github.com/fboucquez/symbol-bootstrap#user-content-command-topics

Also, all these 403 might be related to throttling? The link checker has a mechanism to avoid making too many consecutive requests to the same server, but maybe changing the CI has altered that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Xavi, I think I found the issue with 403 error. If I add with user_agent it seems to fix the problem

sphinx-doc/sphinx#7369 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated link for bootstrap also fix the issue

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

]
linkcheck_anchors_ignore = [r'L\d+']

Expand All @@ -375,8 +379,8 @@ def viewsource_resolve_link(file_path, language=None):

# -- Custom extlinks -----------------------------------------------------

extlinks = {'schema': ('https://github.com/symbol/catbuffer-schemas/blob/main/symbol/%s', 'file '),
'properties': ('https://github.com/symbol/catapult-client/blob/main/resources/%s', 'file ')}
extlinks = {'schema': ('https://github.com/symbol/blob/main/catbuffer/schemas/symbol/%s', 'file '),
'properties': ('https://github.com/symbol/symbol/blob/main/client/catapult/resources/%s', 'file ')}

# -- Custom Pygments lexers ----------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion source/contribute/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ There are plenty of things you can do to help improve |codename|!

|codename| is **Open Source**. Visit the |github| repositories and check if there is any project where you want to contribute.

There is the C++ `Catapult client <https://github.com/symbol/catapult-client>`__ but also Typescript tools like the `Wallets <https://github.com/symbol/desktop-wallet>`__, the `Explorer <https://github.com/symbol/symbol-explorer>`__, `Bootstrap <https://github.com/symbol/symbol-bootstrap>`__ and many more. Each repository's ``README`` and ``CONTRIBUTING`` files will tell you how to submit your code!
There is the C++ `Catapult client <https://github.com/symbol/catapult-client>`__ but also Typescript tools like the `Wallets <https://github.com/symbol/desktop-wallet>`__, the `Explorer <https://github.com/symbol/symbol-explorer>`__, `Bootstrap <https://github.com/fboucquez/symbol-bootstrap>`__ and many more. Each repository's ``README`` and ``CONTRIBUTING`` files will tell you how to submit your code!

👨‍🏫 Can you write?
********************
Expand Down
6 changes: 3 additions & 3 deletions source/guidelines/generating-transaction-builders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Learn how to generate transaction builders for your target SDK language.
Background
**********

The `catbuffer library <https://github.com/symbol/catbuffer-generators>`_ defines the protocol to serialize and deserialize |codename| entities.
The `catbuffer library <https://github.com/symbol/symbol/tree/main/catbuffer>`_ defines the protocol to serialize and deserialize |codename| entities.
The library comes with code generators for different languages.
SDKs and applications use the generated code to interact with REST transaction endpoint.

Expand Down Expand Up @@ -37,7 +37,7 @@ These endpoints allow the addition of new functionality to the client-side witho
Applications can embed the generated code without managing dependencies, which is particularly desirable in highly-secure environments.
Besides, sharing a common codebase enables the addition of new features with less effort.

The `schemas <https://github.com/symbol/catbuffer-schemas/tree/main/symbol>`_ define the entities' data structure.
The `schemas <https://github.com/symbol/symbol/tree/main/catbuffer/schemas/symbol>`_ define the entities' data structure.
The library generates the leanest code necessary to serialize and deserialize defined entities.

************
Expand All @@ -60,7 +60,7 @@ Installation

.. code-block:: bash

git clone https://github.com/symbol/catbuffer-schemas
git clone https://github.com/symbol/symbol/tree/main/catbuffer/schemas

*****
Usage
Expand Down
6 changes: 3 additions & 3 deletions source/guidelines/sdk-development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -167,12 +167,12 @@ Particular decisions we considered:
Transaction Serialization
=========================

The `catbuffer-schemas library <https://github.com/symbol/catbuffer-schemas>`_ defines the protocol to serialize and deserialize |codename| entities.
The `catbuffer-schemas library <https://github.com/symbol/symbol/tree/dev/catbuffer/schemas>`_ defines the protocol to serialize and deserialize |codename| entities.

In combination with the `catbuffer-generators project <https://github.com/symbol/catbuffer-generators/tree/main/generators>`_, developers can generate builder classes for a given set of programming languages.
In combination with the catbuffer generators project, developers can generate builder classes for a given set of programming languages.
For example, the |sdk| uses the generated code to operate with the entities in binary form.

.. note:: If there is no generator for the programming language selected, you will need to develop it first. You can base your work on the `generator <https://github.com/symbol/catbuffer-generators/tree/main/generators/typescript>`_ for TypeScript.
.. note:: If there is no generator for the programming language selected, you will need to develop it first. You can base your work on the `generator <https://github.com/symbol/symbol/tree/dev/sdk/javascript/generator>`_ for TypeScript.

If there is a generator, follow the next steps to generate the builders for all the existent entities:

Expand Down
8 changes: 4 additions & 4 deletions source/guidelines/writing-a-schema.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Writing a Schema

Are you writing a new catapult plugin that includes a new transaction type?

In this guide, we examine how the `transfer.cats <https://github.com/symbol/catbuffer-schemas/blob/main/symbol/transfer/transfer.cats>`_ was constructed.
In this guide, we examine how the `transfer.cats <https://github.com/symbol/blob/main/catbuffer/schemas/symbol/transfer/transfer.cats>`_ was constructed.
You can adapt the same steps to define a new schema.

************
Expand All @@ -15,16 +15,16 @@ Instructions

.. code-block:: bash

git clone https://github.com/symbol/catbuffer-schemas.git
git clone https://github.com/symbol/symbol.git

2. Create a new file under the ``schemas`` folder. In our case, we have named the file ``transfer.cats``.
2. Create a new file under the ``catbuffer/schemas`` folder. In our case, we have named the file ``transfer.cats``.

3. Define the struct for the transaction body.

Think of a struct as a set of properties that we want to store in the same block of memory.

The transaction body contains the extra properties which differ from a basic transaction.
Each attribute can have one of the types defined in `types.cats <https://github.com/symbol/catbuffer-schemas/blob/main/symbol/types.cats>`_.
Each attribute can have one of the types defined in `types.cats <https://github.com/symbol/blob/main/catbuffer/schemas/symbol/types.cats>`_.

.. code-block:: python

Expand Down
6 changes: 3 additions & 3 deletions source/guides/harvesting/activating-remote-harvesting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ To clarify, |symbol-bootstrap| automatically creates a remote account (labelled
Manual activation
*****************

If you have deployed a node yourself, for example by following `the catapult-client instructions <https://github.com/symbol/catapult-client/blob/main/docs/RUNPEERLIN.md>`__, then you have to **enable harvesting manually**.
If you have deployed a node yourself, for example by following `the catapult-client instructions <https://github.com/symbol/symbol/blob/main/client/catapult/docs/RUNPEERLIN.md>`__, then you have to **enable harvesting manually**.

The `catapult-client documentation <https://github.com/symbol/catapult-client/blob/main/docs/RUNPEERLIN.md#user-content-enable-harvesting>`__ explains how to enable :ref:`local harvesting <local-harvesting>`, which stores your main account's private key on the client. This section explains how to enable :ref:`remote harvesting <remote-harvesting>` instead, which uses a proxy account and is therefore **much more secure**.
The `catapult-client documentation <https://github.com/symbol/symbol/blob/main/client/catapult/docs/RUNPEERLIN.md#user-content-enable-harvesting>`__ explains how to enable :ref:`local harvesting <local-harvesting>`, which stores your main account's private key on the client. This section explains how to enable :ref:`remote harvesting <remote-harvesting>` instead, which uses a proxy account and is therefore **much more secure**.

This will be done using the :doc:`symbol-cli </cli>` tool. The required steps are:

Expand Down Expand Up @@ -74,7 +74,7 @@ Run this from a terminal:

Note the **public** and **private** keys for this new account.

Now edit the ``config-harvesting.properties`` file (it should be in a ``resources`` directory if you followed `the catapult-client instructions <https://github.com/symbol/catapult-client/blob/main/docs/RUNPEERLIN.md>`__). Look for the ``harvesterSigningPrivateKey`` field and write the remote account's private key.
Now edit the ``config-harvesting.properties`` file (it should be in a ``resources`` directory if you followed `the catapult-client instructions <https://github.com/symbol/symbol/blob/main/client/catapult/docs/RUNPEERLIN.md>`__). Look for the ``harvesterSigningPrivateKey`` field and write the remote account's private key.

Step 2: Link the remote and main accounts
=========================================
Expand Down
2 changes: 1 addition & 1 deletion source/guides/migration/migrating-from-nem-to-symbol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ Then, the minimum number of cosignatories defined in the multisignature will hav

.. |catapult-schemas| raw:: html

<a href="https://github.com/symbol/catbuffer-schemas/tree/main/symbol/" target="_blank">Serialization schemas</a>
<a href="https://github.com/symbol/symbol/tree/main/catbuffer/schemas/symbol/" target="_blank">Serialization schemas</a>

.. |stack-overflow| raw:: html

Expand Down
2 changes: 1 addition & 1 deletion source/guides/network/maintaining-a-symbol-node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ If you followed the :doc:`running-a-symbol-node-manually` guide, you need to reb
In summary, you need to:

- Stop the running Catapult client with ``Ctrl+C``.
- Update the Catapult client source repository with the latest version and build it again following the `Catapult client <https://github.com/symbol/catapult-client/tree/main/docs>`__ instructions.
- Update the Catapult client source repository with the latest version and build it again following the `Catapult client <https://github.com/symbol/symbol/tree/main/client/catapult/docs>`__ instructions.
- Restart the client from the same folder it was initially launched. Data and configuration files will be reused.

.. note::
Expand Down
2 changes: 1 addition & 1 deletion source/guides/network/running-a-secure-symbol-node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ Preset
-
mainPrivateKey: ●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●

You can read more about these properties in the `security mode section <https://github.com/symbol/symbol-bootstrap/blob/main/docs/presetGuides.md#user-content-private-key-security-mode>`__ in Symbol Bootstrap's documentation.
You can read more about these properties in the `security mode section <https://github.com/fboucquez/symbol-bootstrap/blob/main/docs/presetGuides.md#user-content-private-key-security-mode>`__ in Symbol Bootstrap's documentation.

If you have customizations to make, like enabling :ref:`voting <finalization>`, you can provide them too:

Expand Down
6 changes: 3 additions & 3 deletions source/guides/network/running-a-symbol-node-manually.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Build a Peer node
Build the client
================

Follow the `Catapult client <https://github.com/symbol/catapult-client>`__ instructions to **build** its binaries, either `manually <https://github.com/symbol/catapult-client/blob/main/docs/BUILD-manual.md>`__ or using `Conan <https://github.com/symbol/catapult-client/blob/main/docs/BUILD-conan.md>`__.
Follow the `Catapult client <https://github.com/symbol/catapult-client>`__ instructions to **build** its binaries, either `manually <https://github.com/symbol/symbol/blob/main/client/catapult/docs/BUILD-manual.md>`__ or using `Conan <https://github.com/symbol/symbol/blob/main/client/catapult/docs/BUILD-conan.md>`__.

Generate keys
=============
Expand Down Expand Up @@ -120,7 +120,7 @@ Configuration

|codename| is **highly customizable** and this means there are a lot of parameters that can be adjusted to suit your node's needs. Some of these parameters are **network-related** and must match the rest of nodes in the network (for example ``currencyMosaicId``) whereas some others are **node-related** and you can set freely (for example ``friendlyName``).

You can edit these files manually (Take a look at `these templates <https://github.com/symbol/catapult-client/tree/main/resources>`__ to know how they look) but it is more convenient to use the `Symbol Node Configurator tool <https://github.com/symbol/symbol-node-configurator>`__ as shown next.
You can edit these files manually (Take a look at `these templates <https://github.com/symbol/symbol/tree/main/client/catapult/resources>`__ to know how they look) but it is more convenient to use the `Symbol Node Configurator tool <https://github.com/symbol/symbol-node-configurator>`__ as shown next.

**The Configuration step can be performed on an offline machine for added security.**

Expand Down Expand Up @@ -408,7 +408,7 @@ Run the database

3. **Build indices** to optimize database accesses.

The ``catapult-client`` repository you cloned to build the client in the first step contains `a folder with mongo scripts <https://github.com/symbol/catapult-client/blob/main/scripts/mongo>`__. Run this one:
The ``catapult-client`` repository you cloned to build the client in the first step contains `a folder with mongo scripts <https://github.com/symbol/symbol/blob/main/client/catapult/scripts/mongo>`__. Run this one:

.. code-block:: bash

Expand Down
Loading