Skip to content
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.

Sign up for GitHub

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

Jump to bottom

CLI Docs Consolidation and Update For E-Upgrade #1936

Merged
merged 14 commits into from
Nov 22, 2024
Merged

CLI Docs Consolidation and Update For E-Upgrade #1936

merged 14 commits into from
Nov 22, 2024
+4,216 −937

Conversation

owenwahlgren
Copy link
Contributor

No description provided.

@owenwahlgren owenwahlgren added the DO NOT MERGE This PR is not meant to be merged in its current state label Nov 13, 2024
@owenwahlgren owenwahlgren requested review from amandamarquis1 and a team as code owners November 13, 2024 17:00
@owenwahlgren owenwahlgren linked an issue Nov 13, 2024 that may be closed by this pull request
CLI Docs & Command Tree Consolidation and Update For E-Upgrade #1934
Closed
10 tasks
@vercel Vercel
Copy link

vercel bot commented Nov 13, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
avalanche-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2024 10:43pm

meaghanfitzgerald
meaghanfitzgerald reviewed Nov 21, 2024
View reviewed changes
content/docs/avalanche-l1s/maintain/view-avalanche-l1s.mdx
Comment on lines +25 to +31
+--------------+--------------+---------------------------------------------------+---------------+----------------+---------+
| SUBNET | CHAIN | VM ID | LOCAL NETWORK | FUJI (TESTNET) | MAINNET |
+--------------+--------------+---------------------------------------------------+---------------+----------------+---------+
| myblockchain | myblockchain | qDNV9vtxZYYNqm7TN1mYBuaaknLdefDbFK8bFmMLTJQJKaWjV | Yes | No | No |
+--------------+--------------+---------------------------------------------------+---------------+ +---------+
| test | test | rX1atTpmvt7LHNzqWs9P2KQ66rNh4c7M4CkmYWbHcMaSB8mQN | No | | No |
+--------------+--------------+---------------------------------------------------+---------------+----------------+---------+
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
+--------------+--------------+---------------------------------------------------+---------------+----------------+---------+
| SUBNET | CHAIN | VM ID | LOCAL NETWORK | FUJI (TESTNET) | MAINNET |
+--------------+--------------+---------------------------------------------------+---------------+----------------+---------+
| myblockchain | myblockchain | qDNV9vtxZYYNqm7TN1mYBuaaknLdefDbFK8bFmMLTJQJKaWjV | Yes | No | No |
+--------------+--------------+---------------------------------------------------+---------------+ +---------+
| test | test | rX1atTpmvt7LHNzqWs9P2KQ66rNh4c7M4CkmYWbHcMaSB8mQN | No | | No |
+--------------+--------------+---------------------------------------------------+---------------+----------------+---------+
+--------------+--------------+---------------------------------------------------+---------------+----------------+---------+
| SUBNET | CHAIN | VM ID | LOCAL NETWORK | FUJI (TESTNET) | MAINNET |
+--------------+--------------+---------------------------------------------------+---------------+----------------+---------+
| myblockchain | myblockchain | qDNV9vtxZYYNqm7TN1mYBuaaknLdefDbFK8bFmMLTJQJKaWjV | Yes | No | No |
+--------------+--------------+---------------------------------------------------+---------------+----------------+---------+
| test | test | rX1atTpmvt7LHNzqWs9P2KQ66rNh4c7M4CkmYWbHcMaSB8mQN | No | | No |
+--------------+--------------+---------------------------------------------------+---------------+----------------+---------+

@meaghanfitzgerald
Copy link
Collaborator

New format on the CLI commands page is a downgrade from the current format, which has the headers and tables formatted with better readabililty.

@owenwahlgren
Copy link
Contributor Author

New format on the CLI commands page is a downgrade from the current format, which has the headers and tables formatted with better readabililty.

Redid the generation to better match current layout. Let me know what you think.

meaghanfitzgerald
meaghanfitzgerald reviewed Nov 21, 2024
View reviewed changes
content/docs/tooling/avalanche-cli.mdx Outdated
Comment on lines 33 to 42
- [`addValidator`](#blockchain-addvalidator): The blockchain addValidator command whitelists a primary network validator to
validate the subnet of the provided deployed Blockchain.

To add the validator to the Subnet's allow list, you first need to provide
the blockchainName and the validator's unique NodeID. The command then prompts
for the validation start time, duration, and stake weight. You can bypass
these prompts by providing the values with flags.

This command currently only works on Blockchains deployed to either the Fuji
Testnet or Mainnet.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [`addValidator`](#blockchain-addvalidator): The blockchain addValidator command whitelists a primary network validator to
validate the subnet of the provided deployed Blockchain.
To add the validator to the Subnet's allow list, you first need to provide
the blockchainName and the validator's unique NodeID. The command then prompts
for the validation start time, duration, and stake weight. You can bypass
these prompts by providing the values with flags.
This command currently only works on Blockchains deployed to either the Fuji
Testnet or Mainnet.
- [`addValidator`](#addvalidator): The blockchain addValidator command whitelists a primary network validator to
validate the subnet of the provided deployed Blockchain.
To add the validator to the Subnet's allow list, you first need to provide
the blockchainName and the validator's unique NodeID. The command then prompts
for the validation start time, duration, and stake weight. You can bypass
these prompts by providing the values with flags.
This command currently only works on Blockchains deployed to either the Fuji
Testnet or Mainnet.

all the links on these Subcommands need correction

@meaghanfitzgerald meaghanfitzgerald merged commit e4c17a9 into master Nov 22, 2024
2 of 3 checks passed
@owenwahlgren owenwahlgren deleted the 1934-cli-docs-consolidation-and-update-for-e-upgrade branch November 22, 2024 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@meaghanfitzgerald meaghanfitzgerald meaghanfitzgerald left review comments

@amandamarquis1 amandamarquis1 Awaiting requested review from amandamarquis1 amandamarquis1 is a code owner

Assignees
No one assigned
Labels
9000 DO NOT MERGE This PR is not meant to be merged in its current state
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

CLI Docs & Command Tree Consolidation and Update For E-Upgrade
2 participants
@owenwahlgren @meaghanfitzgerald