Skip to content

OCL Migration #1033

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

Merged
merged 45 commits into from
Mar 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
1bab7a5
chore: remove docker and server infrastructure
a-thomas-22 Mar 25, 2025
ac584b2
chore: update dependencies and package configuration
a-thomas-22 Mar 25, 2025
f9adcad
chore: migrate website configuration to root
a-thomas-22 Mar 25, 2025
43f9999
refactor: migrate documentation content to root level
a-thomas-22 Mar 25, 2025
4b95b5a
chore: remove old website directory structure
a-thomas-22 Mar 25, 2025
0a8c00b
docs: update README for new project structure
a-thomas-22 Mar 25, 2025
6a4fdc6
Trigger CI
a-thomas-22 Mar 25, 2025
569f9b6
chore: update gitignore for root-level project structure
a-thomas-22 Mar 25, 2025
d49c7f0
feat: add root redirect to baseUrl for local development
a-thomas-22 Mar 25, 2025
153c159
Revert "feat: add root redirect to baseUrl for local development"
a-thomas-22 Mar 25, 2025
36730b9
chore: reflect subdir
a-thomas-22 Mar 25, 2025
257a848
docs: fix bazel command in init-state documentation
a-thomas-22 Mar 25, 2025
beb9ffb
fix(docs): replace blockgeeks.com links with web.archive.org
a-thomas-22 Mar 25, 2025
d8d1797
fix(docs): update ethereum.org documentation links
a-thomas-22 Mar 25, 2025
52951b2
fix(docs): update block explorer URLs
a-thomas-22 Mar 25, 2025
ef66b03
fix(docs): update ethereum.org documentation URLs
a-thomas-22 Mar 25, 2025
26070de
fix(docs): update Holesky genesis state file paths
a-thomas-22 Mar 25, 2025
c6ddd62
fix(docs): update internal documentation links
a-thomas-22 Mar 25, 2025
469419b
fix(docs): update various external documentation links
a-thomas-22 Mar 25, 2025
f5dd36a
Update index.js
a-thomas-22 Mar 25, 2025
2d7ac3b
config(url): use vercel env vars for automatic url configuration
a-thomas-22 Mar 25, 2025
7775bc9
Update end-to-end.md
a-thomas-22 Mar 25, 2025
f7b9ed6
revert / removal
a-thomas-22 Mar 25, 2025
dc8fde1
revert / removal
a-thomas-22 Mar 25, 2025
0390eae
revert / removal
a-thomas-22 Mar 25, 2025
f4c6dce
fix link
a-thomas-22 Mar 25, 2025
8e172e4
revert / removal
a-thomas-22 Mar 25, 2025
79c47bd
Add getting started redirect
a-thomas-22 Mar 25, 2025
89c5ec6
fix(404): configure vercel to use custom 404 page
a-thomas-22 Mar 25, 2025
ef14fa9
Trigger CI
a-thomas-22 Mar 25, 2025
821d5c5
feat(404): add custom 404 page content
a-thomas-22 Mar 25, 2025
c53dbf3
adjust 404 routing
a-thomas-22 Mar 25, 2025
1066eda
fix(vercel): remove routes config to fix compatibility
a-thomas-22 Mar 25, 2025
f7407ee
fix links
a-thomas-22 Mar 25, 2025
f12ff5e
redirect getting started
a-thomas-22 Mar 25, 2025
68ef91b
change to docusarus v2
a-thomas-22 Mar 25, 2025
4c02acd
remove invalid redirect
a-thomas-22 Mar 25, 2025
87930e0
move 404 to root
a-thomas-22 Mar 25, 2025
1b7eb9a
Update postbuild.js
a-thomas-22 Mar 25, 2025
d0b692e
update script
a-thomas-22 Mar 25, 2025
8c4557a
fix(404): properly copy 404 directory structure to build root
a-thomas-22 Mar 25, 2025
ff247d0
fix(vercel): include postbuild script in vercel build command
a-thomas-22 Mar 25, 2025
902b2b1
Delete 404.md
a-thomas-22 Mar 25, 2025
fbd2451
add getting started redirect
a-thomas-22 Mar 25, 2025
b164ff8
Revert "Delete 404.md"
a-thomas-22 Mar 25, 2025
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
38 changes: 24 additions & 14 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
.DS_Store
.idea

node_modules
# Dependencies
/node_modules

lib/core/metadata.js
lib/core/MetadataBlog.js
# Production
/build
/dist

website/translated_docs
website/build/
website/yarn.lock
website/node_modules
website/i18n/*
# Generated files
.docusaurus
.cache-loader

website/static/img/~$Prysm_Docs.pptx
# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
.env
.idea/
.vscode/

*.vscode
*.vscode/*
# Logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
logs
*.log
8 changes: 0 additions & 8 deletions Caddyfile

This file was deleted.

35 changes: 0 additions & 35 deletions Dockerfile

This file was deleted.

48 changes: 32 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,53 @@
# Prysm Documentation Portal

This repository houses all the documentation pertaining to the Prysm client and Ethereum 2. It is generated with [Docusaurus](https://github.com/facebook/docusaurus).
This repository houses all the documentation pertaining to the Prysm client and Ethereum. It is generated with [Docusaurus](https://github.com/facebook/docusaurus) and deployed with [Vercel](https://vercel.com/).

Below are steps for initialising and reproducing this portal for development.
Below are steps for initializing and reproducing this portal for development.

## Dependencies

1. The latest version of [Node](https://nodejs.org/en/download/) installed.
2. The latest version of [Yarn](https://yarnpkg.com/en/docs/install) installed. (Optional, but recommended)
1. The latest version of [Node](https://nodejs.org/en/download/) installed.
2. npm (comes with Node.js)

> You have to be on Node >= 8.x and Yarn >= 1.5.
> You have to be on Node >= 8.x.

## Installation

1. Clone this repository.
2. Enter the newly cloned repo and enter the `website` directory.
3. Issue the command `npm install`
2. Enter the newly cloned repo.
3. Issue the command `npm install`.
4. Wait for the installation process to complete.

## Running the development server
## Running the development server

1. From within the `website` directory, run the local web server using `yarn start` or `npm start`.
2. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.
1. From the root directory, run the local web server using `npm start`.
2. Load the example site at http://localhost:3000/prsym/docs if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which.

You should see the example site loaded in your web browser. There's also a LiveReload server running, and any changes made to the docs and files in the project directory will cause the page to refresh.

You should see the example site loaded in your web browser. There's also a LiveReload server running, and any changes made to the docs and files in the `website` directory will cause the page to refresh.


## Building Static HTML Pages

To create a static build of the documentation portal, run the following script from the `website` directory:
To create a static build of the documentation portal, run the following script from the root directory:

```bash
yarn run build # or `npm run build`
npm run build
```

This will generate a `build` subdirectory within the `website` directory, containing the `.html` files from all of the docs and other files included in `pages`.
This will generate a `build` directory containing the `.html` files from all of the docs and other files included in `pages`.

## Deployment with Vercel

This project is configured to be deployed with Vercel. The `vercel.json` file in the root directory contains the necessary configuration for deployment.

To deploy:

1. Push your changes to GitHub.
2. Connect your GitHub repository to Vercel.
3. Vercel will automatically build and deploy the site.

Alternatively, you can use the Vercel CLI to deploy from your local machine:

```bash
npm install -g vercel
vercel
```
File renamed without changes.
18 changes: 0 additions & 18 deletions docker-compose.yml

This file was deleted.

29 changes: 29 additions & 0 deletions docs/404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Page Not Found
description: The requested page could not be found
hide_table_of_contents: true
---

# Page Not Found

Sorry, we couldn't find the page you were looking for. This might be because:

- The page has been moved or renamed
- The URL contains a typo
- The page no longer exists

## What Can You Do?

Here are some helpful links to get you back on track:

- [Getting Started Guide](/) - Learn how to run Prysm
- [Installation Options](//install/install-with-script) - Different ways to install Prysm
- [FAQ](/faq) - Frequently asked questions
- [Technical Documentation](/how-prysm-works/beacon-node) - Deep dive into how Prysm works

You can also:
- Use the search bar at the top of the page
- Check the navigation menu on the left
- [Report this broken link](https://github.com/prysmaticlabs/documentation/issues/new) if you think this is an error

Need more help? Join our [Discord community](https://discord.gg/prysmaticlabs) for support.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ While the default setting is sufficient for regular beacon chain functionality,

## Beacon chain API information

Full details of the Ethereum beacon API are available in the [Ethereum public API section](../how-prysm-works/ethereum-public-api.md).
Full details of the Ethereum beacon API are available in the [Ethereum public API section](/how-prysm-works/ethereum-public-api.md).

## Command line/Configuration file usage:

Expand Down
10 changes: 5 additions & 5 deletions website/docs/advanced/builder.md → docs/advanced/builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Configure MEV Builder

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import BuilderPng from '@site/static/img/builder.png';
import BuilderPng from '@site/static/images/builder.png';

:::caution

Expand Down Expand Up @@ -174,13 +174,13 @@ removing the `--http-mev-relay` flag from the beacon node will disconnect the bu
### Advanced Validator Registration
There are other ways to configure your validator registrations for more granular control on which validator keys should be registered to use the custom builder and which ones should use local execution.
In these cases you would replace the `--suggested-fee-recipient` flag with `--proposer-settings-file` flag or `--proposer-settings-url` flag.
- if configuring with the `--proposer-settings-file` flag and provide it with a suitable JSON or YAML file. This file should include the necessary configuration for the builder. For detailed guidance and an example of this configuration, refer to the [MEV Builder and Gas Limit configuration guide](../execution-node/fee-recipient.md#advanced-configure-mev-builder-and-gas-limit).
- if configuring with the `--proposer-settings-url` flag provide a url that returns the JSON response with the suitable proposer-settings. A guide and example on this configuration can be found [here](../execution-node/fee-recipient.md#advanced-configure-mev-builder-and-gas-limit).
- if configuring with the `--proposer-settings-file` flag and provide it with a suitable JSON or YAML file. This file should include the necessary configuration for the builder. For detailed guidance and an example of this configuration, refer to the [MEV Builder and Gas Limit configuration guide](/execution-node/fee-recipient.md#advanced-configure-mev-builder-and-gas-limit).
- if configuring with the `--proposer-settings-url` flag provide a url that returns the JSON response with the suitable proposer-settings. A guide and example on this configuration can be found [here](/execution-node/fee-recipient.md#advanced-configure-mev-builder-and-gas-limit).
- if configuring with the `--proposer-settings-file` or `--proposer-settings-url` flag with no builder settings but providing the `--enable-builder` flag instead. Optionally, you can also add the `--suggested-gas-limit` to adjust the default gas limit for the builder, this only applies with `--enable-builder`.

:::info

Validators updated through the [Keymanager-API's](../how-prysm-works/keymanager-api.md) fee recipient APIs will take on the default `proposer-settings` provided.
Validators updated through the [Keymanager-API's](/how-prysm-works/keymanager-api.md) fee recipient APIs will take on the default `proposer-settings` provided.

If the `--enable-builder` flag is used without providing `--suggested-fee-recipient`, `--proposer-settings-file`, or `--proposer-settings-url` it will override builder settings from the db if proposer settings are saved, or it will set default builder settings and only save to the db if fee-recipient settings are saved through the keymanager APIs.

Expand Down Expand Up @@ -247,4 +247,4 @@ In the Prysm client, the builder is used through the relay to get transactions t

**Q:** What if the earnings from the builder are lower than from local execution?

**A:** The block from local execution will be used. This could also be triggered through `--local-block-value-boost` if the earnings from the builder don't pass some percentage threshold.
**A:** The block from local execution will be used. This could also be triggered through `--local-block-value-boost` if the earnings from the builder don't pass some percentage threshold.
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Validators should be online as much as possible. If you're running your validato

:::caution

This may be overkill for at-home stakers who use the `prysm.sh` script to run Prysm. To those users, we recommend **keeping it simple** by occasionally checking the status of your validator. See [Check Software Status](../monitoring/checking-status) to learn more.
This may be overkill for at-home stakers who use the `prysm.sh` script to run Prysm. To those users, we recommend **keeping it simple** by occasionally checking the status of your validator. See [Check Software Status](/monitoring/checking-status) to learn more.

:::

### Docker

You can use Docker to run your beacon node and validators as background services. See [Install with Docker](../install/install-with-docker). You can monitor and view your running Docker containers using `docker ps`.
You can use Docker to run your beacon node and validators as background services. See [Install with Docker](/install/install-with-docker). You can monitor and view your running Docker containers using `docker ps`.

### Systemd (Linux)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document provides guidance on migrating Prysm and your validator keys from

:::danger Slashing Prevention

The following best practices will help minimize the risk of [slashing](../concepts/slashing.md) while migrating between machines:
The following best practices will help minimize the risk of [slashing](/concepts/slashing.md) while migrating between machines:

1. Never run more than a single validator process with the same keys loaded.
2. Delete your keys from the old machine before starting your new machine.
Expand Down Expand Up @@ -202,7 +202,7 @@ You can also run the accounts backup command non-interactively by using the foll
**Flag Usage**

| Flag | Usage |
| ------------------------ | :----------------------------------------------------------------------------------------------------- |
|--------------------------|:-------------------------------------------------------------------------------------------------------|
| `--wallet-dir` | Path to a wallet directory (default: "$HOME/Eth2Validators/prysm-wallet-v2") |
| `--wallet-password-file` | Path to a plain-text, .txt file containing your wallet's password. |
| `--backup-dir` | Path to a directory where accounts will be backed up into a zip file. (default: $HOME/Eth2Validators/) |
Expand Down Expand Up @@ -357,5 +357,3 @@ Once complete, verify the account removal using the validator accounts list comm
**When I migrate my slashing protection history from Machine A -> Machine B, or Client A -> Client B, do I need to retain A's slashing protection history after importing to B?**

No. After successfully importing your slashing protection history from A -> B, you can discard A. If you need to migrate from B -> C, B's slashing protection history is all you need to export/import.


Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document provides guidance on moving from Prysm to a new consensus-layer cl

:::danger Slashing Prevention

The following best practices will help minimize the risk of [slashing](../concepts/slashing.md) while migrating between clients:
The following best practices will help minimize the risk of [slashing](/concepts/slashing.md) while migrating between clients:

1. Never run more than a single validator process with the same keys loaded.
2. Maintain and utilize slashing protection.
Expand All @@ -27,7 +27,7 @@ Regardless of which client you are switching to, the first step of the process w

Installation documentation links for each client can be found below:

- Prysm: https://docs.prylabs.network/docs/install/install-with-script
- Prysm: [Quickstart](/install/install-with-script)
- Teku: https://docs.teku.consensys.io/development/get-started/install/install-binaries
- Nimbus: https://nimbus.guide/quick-start.html
- Lighthouse: https://lighthouse-book.sigmaprime.io/installation.html
Expand All @@ -39,19 +39,19 @@ Ensuring you stop and disable Prysm is critical to avoiding slashing events befo

Disabling Prysm prevents it from automatically starting up again after a reboot.

Remove Prysm's validator keys as an added protection by following [these](http://localhost:3000/docs/advanced/migrating-keys#step-5--verification-and-restarting-the-validator-client) instructions.
Remove Prysm's validator keys as an added protection by following [these](/advanced/migrating-keys#step-5--verification-and-restarting-the-validator-client) instructions.

### Step 3: Export slashing protection history

Ensure that you stop Prysm before exporting slashing protection in order to capture all validator actions.

We have a section dedicated to exporting and importing slashing protection history [here.](https://docs.prylabs.network/docs/wallet/slashing-protection) Follow the steps regarding exporting slashing protection history.
We have a section dedicated to exporting and importing slashing protection history [here.](/wallet/slashing-protection) Follow the steps regarding exporting slashing protection history.

### Step 4: Update port forwarding

This step is not required for nodes which are running on a virtual public cloud, but keep in mind - nodes will be required to run a an execution client locally post merge!

By default, Prysm uses TCP/13000 and UDP/12000. Remove those two rules and replace them with the appropriate port forwards for the client you are switching to. The process will be very similar to the steps laid out [here.](https://docs.prylabs.network/docs/prysm-usage/p2p-host-ip#port-forwarding)
By default, Prysm uses TCP/13000 and UDP/12000. Remove those two rules and replace them with the appropriate port forwards for the client you are switching to. The process will be very similar to the steps laid out [here.](/prysm-usage/p2p-host-ip#port-forwarding)

Teku, Nimbus, and Lighthouse all use port 9000 for both TCP and UDP.

Expand Down Expand Up @@ -148,5 +148,3 @@ https://chainsafe.github.io/lodestar/run/validator-management/validator-cli#vali
Ensure your beacon node is fully synced with the network by checking your clients logs prior to starting your validator. Once it is fully synced, start the validator.

Search a block explorer like https://beaconcha.in with your validator's public key to confirm that your validator is now active!


2 changes: 1 addition & 1 deletion website/docs/audits/phase0.md → docs/audits/phase0.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ multiple scenarios.

**Completion Date**: October 6, 2020

**Report link**: [Trail of Bits - Prysm Phase 0 Final Report.pdf](/assets/Trail_of_Bits_Prysm_Phase_0_Final_Report.pdf)
**Report link**: [Trail of Bits - Prysm Phase 0 Final Report.pdf](/assets/Trail_of_Bits_Prysm_Phase_0_Final_Report.pdf)
2 changes: 1 addition & 1 deletion website/docs/concepts/blobs.md → docs/concepts/blobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Blobs
sidebar_label: Blobs
---

import BlobsPng from '@site/static/img/blobs.png';
import BlobsPng from '@site/static/images/blobs.png';


:::info
Expand Down
Loading