From c27ccacb2d26692c38f71089da6b9963a1917981 Mon Sep 17 00:00:00 2001 From: Kurtis Charnock Date: Fri, 14 Feb 2025 10:14:21 +0000 Subject: [PATCH 1/7] doc: correct Rust syntax error in example --- docs/shell/smart_rollup_node.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/shell/smart_rollup_node.rst b/docs/shell/smart_rollup_node.rst index 488d3e885705..fba7806d9f83 100644 --- a/docs/shell/smart_rollup_node.rst +++ b/docs/shell/smart_rollup_node.rst @@ -1525,7 +1525,7 @@ Define these functions in the ``lib.rs`` as follows: mod host; use crate::host::read_input; - use crate::host:ReadInputMessageInfo; + use crate::host::ReadInputMessageInfo; pub const MAX_MESSAGE_SIZE: u32 = 4096u32; -- GitLab From 7c32d113b9e19b6164f4fe1f7a996ef04e86fd46 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 18 Feb 2025 15:10:39 +0100 Subject: [PATCH 2/7] doc: update links to tezos.gitlab.io --- CHANGES.rst | 2 +- README.md | 18 +++++------ docs/alpha/adaptive_issuance.rst | 2 +- docs/alpha/dal_support.rst | 1 + docs/developer/error_monad_p3_advanced.rst | 3 +- docs/developer/images/rpc.excalidraw | 4 +-- docs/developer/python_environment.rst | 2 +- docs/developer/rollup_metrics.csv | 35 ++++++++++++++++++++++ docs/protocols/020_paris.rst | 11 ++++--- docs/protocols/021_quebec.rst | 2 +- docs/quebec/adaptive_issuance.rst | 2 +- docs/releases/version-20.rst | 2 +- docs/rio/adaptive_issuance.rst | 2 +- docs/scripts/extract_content | 2 +- docs/shell/storage.rst | 10 +++---- 15 files changed, 66 insertions(+), 32 deletions(-) create mode 100644 docs/developer/rollup_metrics.csv diff --git a/CHANGES.rst b/CHANGES.rst index ccf6be7ffc23..a16ebcdaff6f 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,7 +1,7 @@ Development Changelog ''''''''''''''''''''' -**NB:** The changelog for releases can be found at: https://tezos.gitlab.io/CHANGES.html +**NB:** The changelog for releases can be found at: https://octez.tezos.com/docs/CHANGES.html This file lists the changes added to each version of octez-node, diff --git a/README.md b/README.md index 6c20216b90b2..29192061024b 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,11 @@ For more information about the project, see https://tezos.com. ## Getting started Instructions to -[install](https://tezos.gitlab.io/introduction/howtoget.html), [start -using](https://tezos.gitlab.io/introduction/howtouse.html), and +[install](https://octez.tezos.com/docs/introduction/howtoget.html), [start +using](https://octez.tezos.com/docs/introduction/howtouse.html), and [taking part in the -consensus](https://tezos.gitlab.io/introduction/howtorun.html) are -available at https://tezos.gitlab.io/. +consensus](https://octez.tezos.com/docs/introduction/howtorun.html) are +available at https://octez.tezos.com/docs/. ## The Tezos software @@ -28,11 +28,11 @@ In more detail, this git repository contains: The Tezos software may run either on the nodes of the main Tezos network (mainnet) or on [various Tezos test -networks](https://tezos.gitlab.io/introduction/test_networks.html). +networks](https://octez.tezos.com/docs/introduction/test_networks.html). The documentation for developers, including developers of the Tezos software and developer of Tezos applications and tools, is available -online at https://tezos.gitlab.io/. This documentation is always in +online at https://octez.tezos.com/docs/. This documentation is always in sync with the master branch which may however be slightly desynchronized with the code running on the live networks. @@ -47,7 +47,7 @@ All development of the Tezos code happens on GitLab at https://gitlab.com/tezos/tezos. Merge requests (https://gitlab.com/tezos/tezos/-/merge_requests) should usually target the `master` branch; see [the contribution -instructions](https://tezos.gitlab.io/developer/contributing.html). +instructions](https://octez.tezos.com/docs/developer/contributing.html). The issue tracker at https://gitlab.com/tezos/tezos/issues can be used to report bugs and to request new simple features. The [Tezos Agora @@ -71,11 +71,11 @@ The core of the Tezos software that implements the economic ruleset is called the *protocol*. Unlike the rest of the source code, updates to the protocol must be further adopted through the [Tezos on-chain voting -procedure](https://tezos.gitlab.io/whitedoc/voting.html). Protocol +procedure](https://octez.tezos.com/docs/active/voting.html). Protocol contributors are encouraged to synchronize their contributions to minimize the number of protocol proposals that the stakeholders have to study and to maximize the throughput of the voting procedure. ## Community -Links to community websites are gathered at . +Links to community websites are gathered at . diff --git a/docs/alpha/adaptive_issuance.rst b/docs/alpha/adaptive_issuance.rst index 708d3f6d99ad..47ce7d3309b5 100644 --- a/docs/alpha/adaptive_issuance.rst +++ b/docs/alpha/adaptive_issuance.rst @@ -433,7 +433,7 @@ Where: The `RPC endpoint -`__, +`__, ``/issuance/expected_issuance`` reports the precomputed values of all participation rewards for the provided block and the next ``issuance_modification_delay`` cycles. diff --git a/docs/alpha/dal_support.rst b/docs/alpha/dal_support.rst index adf1d28f0e0c..ab89063c65ae 100644 --- a/docs/alpha/dal_support.rst +++ b/docs/alpha/dal_support.rst @@ -148,6 +148,7 @@ Penalties A baker that is correctly accused, through an accusation operation included in a block, loses their DAL rewards for the cycle containing the block. +.. _daL_rollups_integration: Smart Rollups integration ========================= diff --git a/docs/developer/error_monad_p3_advanced.rst b/docs/developer/error_monad_p3_advanced.rst index 2a46f600198a..00c5eb479306 100644 --- a/docs/developer/error_monad_p3_advanced.rst +++ b/docs/developer/error_monad_p3_advanced.rst @@ -213,8 +213,7 @@ you are registering: - ``Permanent``: is for irremediable failures, i.e., failures that happen and will always happen whatever the context. E.g., - `originating a - contract `__ + :ref:`originating a contract ` that does not type-check is a permanent error. This is used by the shell to mark the data as invalid. diff --git a/docs/developer/images/rpc.excalidraw b/docs/developer/images/rpc.excalidraw index 741e896b2a2b..ec8ba50a2f09 100644 --- a/docs/developer/images/rpc.excalidraw +++ b/docs/developer/images/rpc.excalidraw @@ -2094,11 +2094,11 @@ "locked": false, "fontSize": 28, "fontFamily": 3, - "text": "Images used in https://tezos.gitlab.io/developer/rpc.html", + "text": "Images used in https://octez.tezos.com/docsab.io/developer/rpc.html", "textAlign": "left", "verticalAlign": "top", "containerId": null, - "originalText": "Images used in https://tezos.gitlab.io/developer/rpc.html", + "originalText": "Images used in https://octez.tezos.com/docsab.io/developer/rpc.html", "autoResize": true, "lineHeight": 1.2 }, diff --git a/docs/developer/python_environment.rst b/docs/developer/python_environment.rst index 96110e8a36fa..89b973a2ddab 100644 --- a/docs/developer/python_environment.rst +++ b/docs/developer/python_environment.rst @@ -1,7 +1,7 @@ Python Environment ================== -Octez uses Python to build this documentation website (:doc:`https://tezos.gitlab.io <../index>`) and for a limited set of +Octez uses Python to build this documentation website (:doc:`https://octez.tezos.com/docs/ <../index>`) and for a limited set of utility scripts (although this latter usage of Python is deprecated). This page contains installation instructions for the Python environment. diff --git a/docs/developer/rollup_metrics.csv b/docs/developer/rollup_metrics.csv new file mode 100644 index 000000000000..f37ff059bc1f --- /dev/null +++ b/docs/developer/rollup_metrics.csv @@ -0,0 +1,35 @@ +Name,Type,Description,Labels +octez_sc_rollup_node_batcher_batches_size,Gauge,"Batcher batches sent", +octez_sc_rollup_node_batcher_get_time,Gauge,"Time to fetch batches", +octez_sc_rollup_node_batcher_inject_time,Gauge,"Time to inject batches", +octez_sc_rollup_node_batcher_last_batch_level,Gauge,"Last batch level", +octez_sc_rollup_node_batcher_last_batch_time,Gauge,"Last batch time", +octez_sc_rollup_node_batcher_message_queue_size,Gauge,"Batcher message queue size", +octez_sc_rollup_node_batcher_messages_size,Gauge,"Batcher messages size in batches", +octez_sc_rollup_node_block_timeout,Gauge,"Number of block before player timeout",opponent;start_level +octez_sc_rollup_node_challenge_window,Gauge,"Current challenge window", +octez_sc_rollup_node_commitment_period,Gauge,"Current commitment period", +octez_sc_rollup_node_dal_attestation_lag,Gauge,"DAL attestation lag", +octez_sc_rollup_node_dal_batcher_queue_length,Gauge,"Number of messages waiting for publication on the DAL", +octez_sc_rollup_node_dal_enabled,Gauge,"DAL enabled in protocol", +octez_sc_rollup_node_dal_injections_queue_length,Gauge,"Number of recently published DAL slots, who have not yet been forgotten", +octez_sc_rollup_node_dal_number_of_slots,Gauge,"DAL number of slots", +octez_sc_rollup_node_gc_oldest_available_level,Gauge,"Oldest Available Level after GC", +octez_sc_rollup_node_gc_process_time,Gauge,"GC processing time", +octez_sc_rollup_node_inbox_external_messages_number,Gauge,"Number of external messages in inbox", +octez_sc_rollup_node_inbox_fetch_time,Gauge,"The time the rollup node spent fetching the inbox", +octez_sc_rollup_node_inbox_internal_messages_number,Gauge,"Number of internal messages in inbox", +octez_sc_rollup_node_inbox_level,Gauge,"Level of last inbox", +octez_sc_rollup_node_inbox_process_time,Gauge,"The time the rollup node spent processing the head", +octez_sc_rollup_node_inbox_total_time,Gauge,"The total time the rollup node spent handling the inbox", +octez_sc_rollup_node_lcc_level_l1,Gauge,"Last cemented commitment level on L1", +octez_sc_rollup_node_lcc_level_local,Gauge,"Last cemented commitment level locally", +octez_sc_rollup_node_lpc_level_l1,Gauge,"Last published commitment on L1", +octez_sc_rollup_node_lpc_level_local,Gauge,"Last published commitment by operator", +octez_sc_rollup_node_node_info,Counter,"General information on the node",version;commit_hash;commit_date +octez_sc_rollup_node_number_of_conflicts,Gauge,"Number of conflicts", +octez_sc_rollup_node_protocol,Counter,"Rollup node current protocol",protocol +octez_sc_rollup_node_rollup_node_info,Counter,"Rollup node info",rollup_address;mode;genesis_level;genesis_hash;pvm_kind;history_mode +octez_sc_rollup_node_state_of_refutation_game,Gauge,"State of refutation game",opponent;start_level + + diff --git a/docs/protocols/020_paris.rst b/docs/protocols/020_paris.rst index 656559a4aa19..1a604eb547b1 100644 --- a/docs/protocols/020_paris.rst +++ b/docs/protocols/020_paris.rst @@ -38,8 +38,8 @@ Data Availability Layer network. Do note that this operation itself does not contain the data themselves. Instead, it contains the slot index, the commitment over the data, and a proof regarding the size for those data. The data must be sent using the - DAL node. For more information on how it works, please read the `DAL - documentation `_. + DAL node. For more information on how it works, please read the :doc:`DAL + documentation <../shell/dal>`. - Optimize the DAL commitment publication operation by memoizing the cryptobox. (MR :gl:`!11594`) @@ -50,8 +50,7 @@ Data Availability Layer enables kernel to read the DAL parameters. This should ease the writing of smart rollups kernels to make them generic over the values of those parameters. For more information on how it works, - please read the `DAL smart rollup integration - `_. + please read :ref:`dal_rollups_integration`. Adaptive Issuance @@ -117,8 +116,8 @@ Breaking Changes - A new ``dal_attestation`` field has been added to the ``block_metadata`` indicating the attested slots. The slots being attested are the slots that were published ``attestation_lag`` levels - ago (MRs :gl:`!11903`, :gl:`!12063`) (see `DAL documentation - `_ for more context). + ago (MRs :gl:`!11903`, :gl:`!12063`) (see :doc:`DAL documentation + <../shell/dal>` for more context). - The protocol no longer relies on stake snapshots to compute rights. Instead: diff --git a/docs/protocols/021_quebec.rst b/docs/protocols/021_quebec.rst index 8b2be0a6e5b6..5424402bff65 100644 --- a/docs/protocols/021_quebec.rst +++ b/docs/protocols/021_quebec.rst @@ -89,7 +89,7 @@ RPC Changes - In the following paths, ``../`` is short for ``/chains//blocks//context/delegates//``. - See https://tezos.gitlab.io/quebec/baking_power.html for more + See :doc:`../active/baking_power` for more details on the renamed and new RPCs. * Renamed RPC ``GET ../current_frozen_deposits`` to ``GET diff --git a/docs/quebec/adaptive_issuance.rst b/docs/quebec/adaptive_issuance.rst index a0dbdc9579e3..d7d09cc16b4f 100644 --- a/docs/quebec/adaptive_issuance.rst +++ b/docs/quebec/adaptive_issuance.rst @@ -437,7 +437,7 @@ Where: The `RPC endpoint -`__, +`__, ``/issuance/expected_issuance`` reports the precomputed values of all participation rewards for the provided block and the next ``consensus_rights_delay`` cycles. diff --git a/docs/releases/version-20.rst b/docs/releases/version-20.rst index ca748609e347..07da9fefcdfc 100644 --- a/docs/releases/version-20.rst +++ b/docs/releases/version-20.rst @@ -54,7 +54,7 @@ Some deprecated RPCs have been removed. Please check `the changelog <../CHANGES. The RPC ``/health/ready`` has been introduced to get the status of the RPC server. -Starting from Octez v20, we strongly advise nodes and bakers operators to synchronise their clocks using NTP as issued in `the node section of getting started `__. +Starting from Octez v20, we strongly advise nodes and bakers operators to synchronise their clocks using NTP as issued in :ref:`start_node`. Smart rollup ~~~~~~~~~~~~ diff --git a/docs/rio/adaptive_issuance.rst b/docs/rio/adaptive_issuance.rst index 8f728cce48e0..8463021a09f7 100644 --- a/docs/rio/adaptive_issuance.rst +++ b/docs/rio/adaptive_issuance.rst @@ -433,7 +433,7 @@ Where: The `RPC endpoint -`__, +`__, ``/issuance/expected_issuance`` reports the precomputed values of all participation rewards for the provided block and the next ``issuance_modification_delay`` cycles. diff --git a/docs/scripts/extract_content b/docs/scripts/extract_content index 9b5cf98a8972..3e5fe42364f8 100755 --- a/docs/scripts/extract_content +++ b/docs/scripts/extract_content @@ -26,7 +26,7 @@ if ($0 !~ /