From e8941be87250eacc62ffae1e18c900811d189fa4 Mon Sep 17 00:00:00 2001 From: Arvid Jakobsson Date: Mon, 11 Sep 2023 14:43:40 +0200 Subject: [PATCH 1/3] Docs: fix some broken links --- docs/alpha/adaptive_issuance.rst | 2 +- docs/conf.py | 1 + docs/developer/long-tezts.rst | 2 +- docs/introduction/tezos.rst | 2 +- docs/oxford/adaptive_issuance.rst | 2 +- docs/user/node-monitoring.rst | 4 ++-- 6 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/alpha/adaptive_issuance.rst b/docs/alpha/adaptive_issuance.rst index dc106bb0b9d5..d016ffc013bd 100644 --- a/docs/alpha/adaptive_issuance.rst +++ b/docs/alpha/adaptive_issuance.rst @@ -32,7 +32,7 @@ This document describes Adaptive Issuance and Staking, two new features of the O .. note:: - For operational details about the new staking mechanism and its configuration, see `a new staking mechanism tutorial `__. + For operational details about the new staking mechanism and its configuration, see `a new staking mechanism tutorial `__. .. _adaptive_issuance_alpha: diff --git a/docs/conf.py b/docs/conf.py index e30be58c512f..4111cb903f89 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -224,6 +224,7 @@ linkcheck_ignore = [ r'^\.\./', # flaky servers, to remove one day if they got more predictable r'^https://opentezos\.com/', + r'^https://crates.io/crates/tezos-smart-rollup', ] linkcheck_allowed_redirects = dict( [ diff --git a/docs/developer/long-tezts.rst b/docs/developer/long-tezts.rst index 3d8482002796..5c3ec3ff7c74 100644 --- a/docs/developer/long-tezts.rst +++ b/docs/developer/long-tezts.rst @@ -219,7 +219,7 @@ Configuring and Running Tezt Long Tests ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For more information about how to use the configuration file, please refer -to the `Long test module API `__. +to the `Long test module API `__. A predefined configuration has already been shipped in :src:`tezt/lib_performance_regression/local-sandbox/tezt_config.json`. It allows to use the InfluxDB and Grafana instances set up by the diff --git a/docs/introduction/tezos.rst b/docs/introduction/tezos.rst index d1af04c889fb..8c1d28aa4db4 100644 --- a/docs/introduction/tezos.rst +++ b/docs/introduction/tezos.rst @@ -41,7 +41,7 @@ The Community - A few community-run websites collect useful Tezos links: - - https://www.tezos.help (resources classified by their kind: organisations, block explorers, wallets, etc.) + - https://tezos.com/ecosystem (resources classified by their kind: organisations, block explorers, wallets, etc.) - https://tezoscommons.org/ (featured resources classified by approach: technology, developing, contributing, etc.) - https://tezos.com/developer-portal/ (resources for developers of applications built on Tezos) diff --git a/docs/oxford/adaptive_issuance.rst b/docs/oxford/adaptive_issuance.rst index 6e11327656bd..6311a3936b6c 100644 --- a/docs/oxford/adaptive_issuance.rst +++ b/docs/oxford/adaptive_issuance.rst @@ -32,7 +32,7 @@ This document describes Adaptive Issuance and Staking, two new features of the O .. note:: - For operational details about the new staking mechanism and its configuration, see `a new staking mechanism tutorial `__. + For operational details about the new staking mechanism and its configuration, see `a new staking mechanism tutorial `__. .. _adaptive_issuance_oxford: diff --git a/docs/user/node-monitoring.rst b/docs/user/node-monitoring.rst index c32de7a35e82..81d79b514a3a 100644 --- a/docs/user/node-monitoring.rst +++ b/docs/user/node-monitoring.rst @@ -223,9 +223,9 @@ Note, if you use filecheck for storage monitoring, you need to configure your da Logs ~~~~ -Eventually, you may want to gather the logs from the different Octez executables. To do so, we suggest to use `Loki `_ and `Promtail `_. Promtail is used to gather the logs from each executable of Octez and pushes them to a Loki instance, for indexing metadata about the logs. +Eventually, you may want to gather the logs from the different Octez executables. To do so, we suggest to use `Loki `_ and `Promtail `_. Promtail is used to gather the logs from each executable of Octez and pushes them to a Loki instance, for indexing metadata about the logs. -You first need to install both tools, following `their installation instructions `_. +You first need to install both tools, following `their installation instructions `_. A configuration file will be required, which can be downloaded with: -- GitLab From a6b40bfd3a9ef73fe2accf6a006a5e671412f88f Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 11 Sep 2023 18:32:49 +0200 Subject: [PATCH 2/3] doc: fix some label refs --- docs/alpha/adaptive_issuance.rst | 2 +- docs/alpha/liquidity_baking.rst | 2 +- docs/oxford/adaptive_issuance.rst | 2 +- docs/oxford/liquidity_baking.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/alpha/adaptive_issuance.rst b/docs/alpha/adaptive_issuance.rst index d016ffc013bd..69cf80da448c 100644 --- a/docs/alpha/adaptive_issuance.rst +++ b/docs/alpha/adaptive_issuance.rst @@ -358,7 +358,7 @@ with the mechanism. It is based on four *pseudo-operations*: ``stake``, ``unstake``, ``finalize_unstake``, and ``set_delegate_parameters``. Pseudo-operations are self-transfers: a transfer operation where the destination matches the source – each involving a special entry-point of -the same name introduced for `implicit accounts `__. +the same name introduced for :ref:`implicit accounts `. This approach was chosen to minimize the work required by wallets, custodians, exchanges, and other parties to support the functionality. diff --git a/docs/alpha/liquidity_baking.rst b/docs/alpha/liquidity_baking.rst index 44184bfa341b..cc29db770b34 100644 --- a/docs/alpha/liquidity_baking.rst +++ b/docs/alpha/liquidity_baking.rst @@ -32,7 +32,7 @@ CPMM contract, and the CPMM's ``%default`` entrypoint is called to update the CPMM contract is 1/16th of the rewards for a block of round 0 with all attestations; currently these rewards are 20 tez per block so the amount that is sent to the CPMM contract is 1.25 tez per block. -If the :ref:adaptive issuance feature were to be activated, +If the :ref:`adaptive issuance ` feature were to be activated, the subsidy would be adjusted by the adaptive issuance coefficient. So the credits to the CPMM contract can be accounted for by indexers, they are included in block metadata as a balance update with a new constructor for ``update_origin``, ``Subsidy``. diff --git a/docs/oxford/adaptive_issuance.rst b/docs/oxford/adaptive_issuance.rst index 6311a3936b6c..3a3ad15682e5 100644 --- a/docs/oxford/adaptive_issuance.rst +++ b/docs/oxford/adaptive_issuance.rst @@ -359,7 +359,7 @@ with the mechanism. It is based on four *pseudo-operations*: ``stake``, ``unstake``, ``finalize_unstake``, and ``set_delegate_parameters``. Pseudo-operations are self-transfers: a transfer operation where the destination matches the source – each involving a special entry-point of -the same name introduced for `implicit accounts `__. +the same name introduced for :ref:`implicit accounts `. This approach was chosen to minimize the work required by wallets, custodians, exchanges, and other parties to support the functionality. diff --git a/docs/oxford/liquidity_baking.rst b/docs/oxford/liquidity_baking.rst index 7936b433b342..154986d81674 100644 --- a/docs/oxford/liquidity_baking.rst +++ b/docs/oxford/liquidity_baking.rst @@ -32,7 +32,7 @@ CPMM contract, and the CPMM's ``%default`` entrypoint is called to update the CPMM contract is 1/16th of the rewards for a block of round 0 with all attestations; currently these rewards are 20 tez per block so the amount that is sent to the CPMM contract is 1.25 tez per block. -If the :ref:adaptive issuance feature were to be activated, +If the :ref:`adaptive issuance ` feature were to be activated, the subsidy would be adjusted by the adaptive issuance coefficient. So the credits to the CPMM contract can be accounted for by indexers, they are included in block metadata as a balance update with a new constructor for ``update_origin``, ``Subsidy``. -- GitLab From 78994951950ab2eac38db9170795cd63961bd526 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 25 Sep 2023 10:24:42 +0200 Subject: [PATCH 3/3] doc: fix values for feature activation vote --- docs/releases/version-18.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/version-18.rst b/docs/releases/version-18.rst index c887d80411e7..b8a147497a4a 100644 --- a/docs/releases/version-18.rst +++ b/docs/releases/version-18.rst @@ -40,7 +40,7 @@ The Oxford protocol includes 3 features (all part of Adaptive Issuance and the n - the ability for *delegators* to become *stakers*; and, - the changes in weight for *staked* and *delegated* funds towards the computation of baking and voting rights. -Instead, these are guarded behind a *single* per-block vote mechanism, where bakers signal their position **(Yes, No, Pass)**. +Instead, these are guarded behind a *single* per-block vote mechanism, where bakers signal their position **(On, Off, Pass)**. Specifically, the Octez v18.0 Oxford baker executable introduces a dedicated option ``--adaptive-issuance-vote``, to allow bakers to manifest their choice. The use of this flag is *optional*, and defaults to **Pass** if not present. -- GitLab