Update Beta documentation index#284 #290
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for obol-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Kudos, SonarCloud Quality Gate passed!
|
thomasheremans
approved these changes
Nov 29, 2023
| @@ -39,18 +39,18 @@ To create alerts for Node-Exporter, follow these steps based on the sample rules | |||
| 5. Finally, save and apply the configuration file. Prometheus should now trigger alerts based on these rules. | |||
|
|
|||
|
|
|||
| For alerts specific to Charon/Alpha, refer to the alerting rules available on this [ObolNetwork/monitoring](https://github.com/ObolNetwork/monitoring/tree/main/alerting-rules). | |||
| For alerts specific to Charon/Beta, refer to the alerting rules available on this [ObolNetwork/monitoring](https://github.com/ObolNetwork/monitoring/tree/main/alerting-rules). | |||
There was a problem hiding this comment.
I would remove all mentions of Alpha/beta from this page and try to keep alerts as generic as possible
OisinKyne
reviewed
Nov 29, 2023
| @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; | |||
| # Activate a DV | |||
|
|
|||
| :::caution | |||
| Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
There was a problem hiding this comment.
Suggested change
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |
| Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). |
Comment on lines
+46
to
+53
| 1. `ClusterBeaconNodeDown`This alert is activated when the beacon node in a specified Beta cluster is offline. The beacon node is crucial for validating transactions and producing new blocks. Its unavailability could disrupt the overall functionality of the cluster. | ||
| 2. `ClusterBeaconNodeSyncing`This alert indicates that the beacon node in a specified Beta cluster is synchronizing, i.e., catching up with the latest blocks in the cluster. | ||
| 3. `ClusterNodeDown`This alert is activated when a node in a specified Beta cluster is offline. | ||
| 4. `ClusterMissedAttestations`:This alert indicates that there have been missed attestations in a specified Beta cluster. Missed attestations may suggest that validators are not operating correctly, compromising the security and efficiency of the cluster. | ||
| 5. `ClusterInUnknownStatus`: This alert is designed to activate when a node within the cluster is detected to be in an unknown state. The condition is evaluated by checking whether the maximum of the app_monitoring_readyz metric is 0. | ||
| 6. `ClusterInsufficientPeers`:This alert is set to activate when the number of peers for a node in the Alpha M1 Cluster #1 is insufficient. The condition is evaluated by checking whether the maximum of the **`app_monitoring_readyz`** equals 4. | ||
| 7. `ClusterFailureRate`: This alert is activated when the failure rate of the Alpha M1 Cluster #1 exceeds a certain threshold. | ||
| 8. `ClusterVCMissingValidators`: This alert is activated if any validators in the Alpha M1 Cluster #1 are missing. | ||
| 6. `ClusterInsufficientPeers`:This alert is set to activate when the number of peers for a node in the Beta M2 Cluster #1 is insufficient. The condition is evaluated by checking whether the maximum of the **`app_monitoring_readyz`** equals 4. | ||
| 7. `ClusterFailureRate`: This alert is activated when the failure rate of the Beta M2 Cluster #1 exceeds a certain threshold. | ||
| 8. `ClusterVCMissingValidators`: This alert is activated if any validators in the Beta M2 Cluster #1 are missing. |
There was a problem hiding this comment.
Agree with Thomas that this doesn't make a whole load of sense. Alpha M1 is the name of a particular example cluster, not some term to be changed to Beta M2.
| @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; | |||
| # Run a cluster with MEV enabled | |||
|
|
|||
| :::caution | |||
| Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
There was a problem hiding this comment.
Suggested change
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |
| Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). |
| @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; | |||
|
|
|||
| :::caution | |||
|
|
|||
| The Obol-SDK is in an alpha state and should be used with caution., particularly on mainnet. | |||
| The Obol-SDK is in an beta state and should be used with caution., particularly on mainnet. | |||
There was a problem hiding this comment.
Suggested change
| The Obol-SDK is in an beta state and should be used with caution., particularly on mainnet. | |
| The Obol-SDK is in a beta state and should be used with caution, only on testnet. |
| @@ -6,7 +6,7 @@ description: Split existing validator keys | |||
| # Split existing validator private keys | |||
|
|
|||
| :::caution | |||
| Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
There was a problem hiding this comment.
Suggested change
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |
| Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). |
| @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; | |||
| # Creator & Leader Journey | |||
|
|
|||
| :::caution | |||
| Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
There was a problem hiding this comment.
Suggested change
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |
| Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). |
| @@ -6,7 +6,7 @@ description: A node operator joins a DV cluster | |||
| # Operator Journey | |||
|
|
|||
| :::caution | |||
| Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
There was a problem hiding this comment.
Suggested change
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |
| Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). |
| @@ -1,7 +1,7 @@ | |||
| # Quickstart Guides | |||
|
|
|||
| :::caution | |||
| Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
There was a problem hiding this comment.
Suggested change
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |
| Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). |
| @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; | |||
| # Exit a DV | |||
|
|
|||
| :::caution | |||
| Charon is in an alpha state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |||
There was a problem hiding this comment.
Suggested change
| Charon is in an beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). | |
| Charon is in a beta state and should be used with caution according to its [Terms of Use](https://obol.tech/terms.pdf). |
| @@ -6,7 +6,7 @@ description: Run a cluster on mainnet | |||
| # Run a DV on mainnet | |||
|
|
|||
| :::caution | |||
| Charon is in an alpha state, and you should proceed only if you accept the risk, the [terms of use](https://obol.tech/terms.pdf), and have tested running a Distributed Validator on a testnet first. | |||
| Charon is in an beta state, and you should proceed only if you accept the risk, the [terms of use](https://obol.tech/terms.pdf), and have tested running a Distributed Validator on a testnet first. | |||
There was a problem hiding this comment.
Suggested change
| Charon is in an beta state, and you should proceed only if you accept the risk, the [terms of use](https://obol.tech/terms.pdf), and have tested running a Distributed Validator on a testnet first. | |
| Charon is in a beta state, and you should proceed only if you accept the risk, the [terms of use](https://obol.tech/terms.pdf), and have tested running a Distributed Validator on a testnet first. |
|
Suggesting we close this PR as most of the changes went in on #288, hence the conflicts. Monitoring guide could still do with being updated to refer to a cluster with a generic name rather than Alpha M1 though. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Revise and correct documentation to remove alpha warnings and update references with beta.
Details
All references to Alpha phase has been replaced with Beta in order to align with Beta phase announcement.
ticket:
https://app.zenhub.com/workspaces/obol-workspace-648c1170ee94656741353327/issues/gh/obolnetwork/obol-docs/284