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] updated governance doc #5778

Merged
merged 7 commits into from
Dec 11, 2022
Merged

[docs] updated governance doc #5778

merged 7 commits into from
Dec 11, 2022

Conversation

0xchloe
Copy link
Contributor

@0xchloe 0xchloe commented Dec 6, 2022

Description

Added more details to the governance doc. Lmk if I'm missing anything, would be happy to add more : )

Test Plan

@clay-aptos
Copy link
Contributor

And when this lands, I will update See what's new to summarize it:
https://aptos.dev/whats-new-in-docs

Thanks, @0xchloe !

@0xchloe 0xchloe force-pushed the governance_docs branch 2 times, most recently from c8f59ae to 657fe76 Compare December 7, 2022 03:45
@@ -33,9 +33,9 @@ sources={{

## Who can propose

- To either propose or vote, you must stake but you are not required to run a validator node. However, we recommend that you be a validator with a stake and be a part of the validator set.
- To either propose or vote, you must stake, but you are not required to run a validator node. However, we recommend that you be a validator with a stake and be a part of the validator set.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Rationale for why becoming a validator is recommended is that users will also gain rewards.


## Aptos Improvement Proposals (AIPs)

AIPs are proposals created by the Aptos community or the Aptos Labs team to improve the operations and development of the Aptos chain.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would omit "the Aptos Labs team"

## Aptos Improvement Proposals (AIPs)

AIPs are proposals created by the Aptos community or the Aptos Labs team to improve the operations and development of the Aptos chain.
To submit an AIP, create an issue in [`Aptos Foundation's github repository`](https://github.com/aptos-foundation/AIPs/issues).
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add a callout that they should also follow the template there?

The `aptos_governance` module outlines how users can interact with Aptos Governance. It's the external-facing module of the Aptos on-chain governance process and contains logic and checks that are specific to Aptos Governance.
The `voting` module is the Aptos governance standard that can be used by DAOs on the Aptos chain to create their own on-chain governance process.

If you are thinking about creating a DAO on Aptos, you can refer to `aptos_governance`'s usage of the `voting` module as an example.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add more details on the functionalities of the voting module and may be just simple explanation of how a DAO can leverage them? We'll add a more detailed tutorial soon.


## Aptos Improvement Proposals (AIPs)

AIPs are proposals created by the Aptos community or the Aptos Labs team to improve the operations and development of the Aptos chain.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
AIPs are proposals created by the Aptos community or the Aptos Labs team to improve the operations and development of the Aptos chain.
AIPs are proposals created by the Aptos community to improve the operations and development of the Aptos blockchain.

@davidiw davidiw enabled auto-merge (squash) December 11, 2022 03:31
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions
Copy link
Contributor

✅ Forge suite land_blocking success on 56fd8c979a4b61bad73320f1dce8b162acfb1147

performance benchmark with full nodes : 6549 TPS, 6062 ms latency, 12700 ms p99 latency,(!) expired 280 out of 2796960 txns
Test Ok

@github-actions
Copy link
Contributor

✅ Forge suite compat success on testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 56fd8c979a4b61bad73320f1dce8b162acfb1147

Compatibility test results for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 56fd8c979a4b61bad73320f1dce8b162acfb1147 (PR)
1. Check liveness of validators at old version: testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b
compatibility::simple-validator-upgrade::liveness-check : 7144 TPS, 5569 ms latency, 8500 ms p99 latency,no expired txns
2. Upgrading first Validator to new version: 56fd8c979a4b61bad73320f1dce8b162acfb1147
compatibility::simple-validator-upgrade::single-validator-upgrade : 4831 TPS, 8433 ms latency, 11100 ms p99 latency,no expired txns
3. Upgrading rest of first batch to new version: 56fd8c979a4b61bad73320f1dce8b162acfb1147
compatibility::simple-validator-upgrade::half-validator-upgrade : 4978 TPS, 8135 ms latency, 10300 ms p99 latency,no expired txns
4. upgrading second batch to new version: 56fd8c979a4b61bad73320f1dce8b162acfb1147
compatibility::simple-validator-upgrade::rest-validator-upgrade : 6631 TPS, 5848 ms latency, 9600 ms p99 latency,no expired txns
5. check swarm health
Compatibility test for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 56fd8c979a4b61bad73320f1dce8b162acfb1147 passed
Test Ok

@davidiw davidiw disabled auto-merge December 11, 2022 18:13
@davidiw davidiw merged commit 7c09e05 into main Dec 11, 2022
@davidiw davidiw deleted the governance_docs branch December 11, 2022 18:13
@davidiw
Copy link
Contributor

davidiw commented Dec 11, 2022

And when this lands, I will update See what's new to summarize it: https://aptos.dev/whats-new-in-docs

Thanks, @0xchloe !

@clay-aptos it landed

@clay-aptos
Copy link
Contributor

And when this lands, I will update See what's new to summarize it: https://aptos.dev/whats-new-in-docs
Thanks, @0xchloe !

@clay-aptos it landed

Thanks! Announcement PR here:
#5862

Also see a lingering question on an accompanying code comment I have above. Thanks again.

areshand pushed a commit to areshand/aptos-core-1 that referenced this pull request Dec 18, 2022
* rebased

* Update developer-docs-site/docs/concepts/governance.md

* Update developer-docs-site/docs/concepts/governance.md

* Update developer-docs-site/docs/concepts/governance.md

* Update developer-docs-site/docs/concepts/governance.md

* Update developer-docs-site/docs/concepts/governance.md

* Update developer-docs-site/docs/concepts/governance.md

Co-authored-by: chloeqjz <[email protected]>
Co-authored-by: David Wolinsky <[email protected]>
@Markuze Markuze mentioned this pull request Dec 26, 2022
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.

4 participants