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.

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

docs: change-parameters proposal #174

Merged
merged 1 commit into from
Dec 8, 2023
Merged

Conversation

ptrus
Copy link
Member

@ptrus ptrus commented Dec 8, 2023

No description provided.

docs/network.md Outdated
@@ -206,6 +206,8 @@ The following proposal types are currently supported:

- `upgrade <descriptor.json>`: Network upgrade proposal. Provide a JSON file
containing the upgrade descriptor.
- `parameter-change <module-name> <changes.json>`: Network parameter change
proposal. Provide the module name and the consensus parameter changes JSON.
Copy link
Member

Choose a reason for hiding this comment

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

Is there a place where all possible module names are listed?

Copy link
Member Author

Choose a reason for hiding this comment

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

These are the consensus modules. Not sure if there's a list somewhere. Idk how useful even would be listing that, someone creating a parameter change proposal needs somewhat in-depth knowledge of the oasis-core code anyway.

docs/network.md Outdated
@@ -206,6 +206,8 @@ The following proposal types are currently supported:

- `upgrade <descriptor.json>`: Network upgrade proposal. Provide a JSON file
containing the upgrade descriptor.
- `parameter-change <module-name> <changes.json>`: Network parameter change
Copy link
Member

Choose a reason for hiding this comment

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

Let's order the proposal names by name (cancel-upgrade, parameter-change, upgrade).

@@ -319,7 +321,7 @@ The provided ID can be one of the following:

- If the [ParaTime ID] is provided, Oasis CLI shows ParaTime information stored
in the network's registry.

Copy link
Member

Choose a reason for hiding this comment

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

Revert.

@@ -345,7 +347,7 @@ The provided ID can be one of the following:
ParaTimes, trusted execution environment support and more. For example:

![code shell](../examples/network-show/id-node.in.static)

Copy link
Member

Choose a reason for hiding this comment

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

Revert.

Copy link
Member Author

@ptrus ptrus Dec 8, 2023

Choose a reason for hiding this comment

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

But then it's inconsistent with

cli/docs/network.md

Lines 341 to 343 in 818e4d4

![code shell](../examples/network-show/id-entity.in)
![code json](../examples/network-show/id-entity.out)

Where it's the exact same pattern but the middle line is stripped.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, never mind. I thought it was just a leftover of yours. Yes, keep it consistent.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah it's an auto-strip by editor 😁

@ptrus ptrus force-pushed the ptrus/feature/create-proposal-docs branch 2 times, most recently from 60813bc to 1491ff4 Compare December 8, 2023 13:14
@ptrus ptrus force-pushed the ptrus/feature/create-proposal-docs branch from 1491ff4 to c6c04dc Compare December 8, 2023 13:59
@@ -345,7 +347,7 @@ The provided ID can be one of the following:
ParaTimes, trusted execution environment support and more. For example:

![code shell](../examples/network-show/id-node.in.static)

Copy link
Member

Choose a reason for hiding this comment

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

Oh, never mind. I thought it was just a leftover of yours. Yes, keep it consistent.

@ptrus ptrus merged commit 6ca8b3d into master Dec 8, 2023
3 checks passed
@ptrus ptrus deleted the ptrus/feature/create-proposal-docs branch December 8, 2023 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants