From ebc390fa01c9915a4a8169d3ecea1875b479f2f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Germ=C3=A1n=20Delbianco?= Date: Thu, 2 Jan 2025 11:58:35 +0000 Subject: [PATCH 1/7] docs/key management: make minor nits in consensus key section --- docs/user/key-management.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user/key-management.rst b/docs/user/key-management.rst index f9d6f81d16ab..edf84da7e747 100644 --- a/docs/user/key-management.rst +++ b/docs/user/key-management.rst @@ -287,11 +287,11 @@ The operation is signed by the manager key and does not require the consensus pr However the public key must be known by the client. It can be imported with the command:: - octez-client import public key consensus unencrypted:edpk... + octez-client import public key unencrypted:edpk... The command to update the consensus key is:: - octez-client set consensus key for to consensus + octez-client set consensus key for to The update becomes active after ``CONSENSUS_RIGHTS_DELAY + 1`` cycles. We therefore distinguish the active consensus key and the pending consensus keys. @@ -299,7 +299,7 @@ The active consensus key is by default the delegate’s manager key, which canno However, it is also possible to register as a delegate and immediately set the consensus key:: - octez-client register key as delegate with consensus key + octez-client register key as delegate with consensus key There can be multiple pending updates: it is possible to have multiple pending consensus keys for multiple future cycles. A subsequent update within the same cycle takes precedences over the initial one. -- GitLab From 772b854117c4ba18ea652cda81ed483f56a68bf4 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 10 Jan 2025 10:03:19 +0100 Subject: [PATCH 2/7] doc: mention client command get staked balance --- docs/alpha/staking.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/alpha/staking.rst b/docs/alpha/staking.rst index 9f38072db51e..b4f27c2945d1 100644 --- a/docs/alpha/staking.rst +++ b/docs/alpha/staking.rst @@ -149,6 +149,11 @@ or more conveniently:: octez-client stake for +The staked amount and remaining spendable funds can then be checked respectively with:: + + octez-client get staked balance for + octez-client get balance for + To *unstake* funds, a staker first submits an unstake request with the ``unstake`` pseudo-operation. This is implemented by transferring the chosen amount in tez to their ``unstake`` entry-point:: -- GitLab From 8233ca255f783b4fbdab93f6a6d1d07d0361536d Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 14 Jan 2025 09:31:32 +0100 Subject: [PATCH 3/7] doc: link to OpenTezos on home page --- docs/index.rst | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 26b4058c6a4d..f817ceab1bc4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,10 +14,7 @@ This documentation describes an implementation of the `Tezos blockchain Date: Tue, 14 Jan 2025 17:29:56 +0100 Subject: [PATCH 4/7] Docs: fix typo in netdata setup --- docs/user/node-monitoring.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user/node-monitoring.rst b/docs/user/node-monitoring.rst index b754c593f7cb..718f1ad470cc 100644 --- a/docs/user/node-monitoring.rst +++ b/docs/user/node-monitoring.rst @@ -209,7 +209,7 @@ To install Netdata: bash <(curl -Ss https://my-netdata.io/kickstart.sh) -Add the following at the end of ``/etc/netdata/app_groups.conf`` +Add the following at the end of ``/etc/netdata/apps_groups.conf`` .. code-block:: shell -- GitLab From e86e01484d4ad108cb0aeb04d98519c577121bf7 Mon Sep 17 00:00:00 2001 From: Julien Sagot Date: Wed, 15 Jan 2025 11:31:05 +0100 Subject: [PATCH 5/7] Docs/grafazos: fix link to Grafonnet repo --- grafazos/doc/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/grafazos/doc/index.rst b/grafazos/doc/index.rst index 12b0304362fd..990f22a479c5 100644 --- a/grafazos/doc/index.rst +++ b/grafazos/doc/index.rst @@ -19,7 +19,7 @@ Grafonnet ``Grafonnet`` is the jsonnet library used to generate grafana dashboards. -``Grafonnet`` should be installed using `jsonnet-bundler `__. +``Grafonnet`` should be installed using `jsonnet-bundler `__. To do so, run ``go install -a github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest`` and update your environment variables such as ``export GOPATH=$HOME/go`` and ``export PATH=$PATH:$GOPATH/bin``. -- GitLab From e03e0b390636c7530b40fa8f2b4247040c522c47 Mon Sep 17 00:00:00 2001 From: Julien Sagot Date: Wed, 15 Jan 2025 11:45:06 +0100 Subject: [PATCH 6/7] Docs/grafazos: fix code instruction markup --- grafazos/doc/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/grafazos/doc/index.rst b/grafazos/doc/index.rst index 990f22a479c5..edd5dae5e40d 100644 --- a/grafazos/doc/index.rst +++ b/grafazos/doc/index.rst @@ -25,9 +25,9 @@ To do so, run ``go install -a github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@ Once ``jsonnet-bundler`` installed you can import dependencies (here ``grafonnet``) by running the following: -```sh -jb install -``` +.. code-block:: shell + + jb install Tools ----- -- GitLab From 22b20a1205151e53ca0326001a373dc398f25018 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 16 Jan 2025 14:58:53 +0100 Subject: [PATCH 7/7] doc: add redirect for latest release page --- docs/_redirects | 1 + docs/_redirects.s3 | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/_redirects b/docs/_redirects index 83f94b663348..5cfc0f79ee5a 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,3 +1,4 @@ +/releases/latest.html /releases/version-21.html 302 /007/cli-commands.html https://octez.tezos.com/docs/shell/cli-commands.html 301 /007/* https://octez.tezos.com/docs/alpha/:splat 301 /009/glossary.html /active/glossary.html 301 diff --git a/docs/_redirects.s3 b/docs/_redirects.s3 index 2a285ed73f19..08c100c8aa79 100644 --- a/docs/_redirects.s3 +++ b/docs/_redirects.s3 @@ -3,3 +3,4 @@ # this one is temporary, just for testing: /install.html /introduction/howtoget.html 301 +/releases/latest.html /releases/version-21.html 302 -- GitLab