Revamp Governance Section: Proposal for a restructured and accurate section

[thenic95]

Hi everyone,

I think it's about time that we think about how to properly restructure and repurpose the governance section.

The current information could be more varied, and as the Chang Hard Fork is about to happen sometime in 2024, we should think about revamping the section to keep it up-to-date.

I have included my proposal below for you to take a look at. I would mainly want to rewrite the Overview.md file in the main category and build out the two new sub-categories, Cardano Governance and Governance Tutorials.

Please let me know what you think and if you would like to contribute, please let me know 😃

Proposed New Structure

Main-Category: Participate in Governance

Current Name: Be Part of the Governance

Structure of Main-Category

• Overview
  • Heading: Participate in Governance
    • Short Introduction
  • Heading: Cardano Governance
    • Updated text
  • Heading: Cardano Improvement Proposal (CIPs)
  • Heading: Cardano Problem Statements (CPSs)
  • Heading: Fund your project with Project Catalyst
• Sub-Category: Cardano Governance -> See below
• Governance Action Overview
  • Content: Detailed explanation of governance actions, voting thresholds, and participants.
    • Headings: Types of governance actions, eligibility for voting.
• Sub-Category: Governance Tutorials -> See below
• Cardano Improvement Proposals (C.I.P.) - Stays the Same
• Cardano Problem Statements (CPS) - Stays the Same
• Project Catalyst - TBD

Structure Sub-Category Cardano Governance

• Contents:
  • Heading: Cardano's Governance Model
    • Introduction: A brief explanation of the on-chain governance system, emphasizing the tri-cameral model.
  • Sub-Heading:
    • Delegated Representatives (DReps): Their roles within the governance model.
    • Stake Pool Operators (SPOs): Overview of their function.
    • Constitutional Committee (CC): Introduction to its purpose and activities.
  • Heading: Decision-Making Process
    • Overview of governance actions, detailing the process from proposal to decision.

Structure Sub-Category Governance Tutorials

• File: Overview.md
  • Content: Explain the intricacies of using the CLI for voting purposes. Link to install node example. Link to other governance tooling that doesn’t require the node
• File: tutorials-drep.md
  • Contents: Explanation of DReps' roles, registration, and voting processes.
    • Heading: Registration and Deregistration: Guide
    • Heading: Voting as a DRep: Tutorial
    • Heading: How to host your DRep Metadata: (e.g. via GitHub)
    • Heading: Useful Queries: CLI Queries
    • Heading: Key Management: Advice on using an air-gapped machine for security.
• File: tutorials-spo.md
  • Contents: Explain the roles of SPO in the on-chain governance system
    • Heading: Voting Tutorial: https://sancho.network/tutorials/vote-action/
• File: tutorials-cc.md
  • Contents: Overview of the CC's role within Cardano's governance.
    • Heading: Cold Committee Keys Creation: Tutorial
    • Heading: Hot Committee Keys Creation: Tutorial
    • Heading: Voting with CC Keys: Explanation on how to vote.
• File: tutorials-ada-holder.md
  • Contents: Overview of ADA holders' capabilities within governance.
    • Heading: Creating a Governance Action: Guide
    • Heading: Querying Votes of DReps and SPOs
    • Heading: Delegating to a DRep: Tutorial

Screenshot of How it might look like

[rphair]

@thenic95 that looks good to me so far. Other than CIPs (+ CPS) I can't really contribute to this material with anything more than structural & verbal proofreading, and will keep an eye on the new PRs for this outline in that regard. I've begun notifying some other potential contributors about this issue privately in case interested in the new topics.

I see none of the new material relates to the CIP process, which makes sense since I think @katomm or associate(s) had re-worked this shortly after that process had its last significant update. When the new outline starts to fill out I'll go over the CIP-related stuff again in case anything needs update or amendment. Also, my current Catalyst project is producing a "CIP Wiki" in its next milestone and I'll submit a link to this in the evolving material when ready.

[Ryun1]

Happy to help, and contribute to the Cardano Governance sections 💪

[thenic95]

Thank you @rphair and @Ryun1! Next week I plan to create a more detailed plan, also a contribution plan. I think it would make a lot of sense to create a new governance revamp branch we can work on asysnchronously. Would you suggest this approach?

[rphair]

@thenic95 create a new governance revamp branch we can work on asysnchronously

yes: I don't think we could have gotten so many contributors for the new SPO material unless that approach was taken, so likewise it should work well for the governance material. @katomm and @fill-the-fill were the ones who created & joined that branch with the mainstream so I would coordinate it with them. 🤓

[thenic95]

Project Plan for Revamping the Governance Section

Objective

Update and enhance the governance section to reflect the latest developments, particularly the Chang Hard Fork, and introduce new sub-categories for improved navigation and comprehension.

Tasks

1. Preparation

• Define precise objectives for the update. -> Assigned to: @thenic95
• Create an overview of all the new sites and updates we require, -> Assigned to: @thenic95
• Have a new branch created for the governance-revamp. -> Assigned to: @fill-the-fill
• Implement the currently proposed structure on the new branch and create empty pages that require content. -> Assigned to: @thenic95

2. Content Development

Update Main Category

• Rewrite the Overview.md file of the Main Category to reflect the current status quo of Governance accurately. -> Assigned to: @thenic95

Cardano Governance

• Create Sub-Category "Cardano Governance" -> Assigned to: @thenic95

• Create an Overview.md file that explains the Cardano Governance model (Please refer to the above mentioned outline) -> Assigned to: @thenic95

  Content to be included

  • Cardano's Governance Model: A brief explanation of the on-chain governance system, emphasizing the tri-cameral model. -> Assigned to: @thenic95
  • Delegated Representatives (DReps): Their roles within the governance model. -> Assigned to: @thenic95
  • Stake Pool Operators (SPOs): Overview of their function. -> Assigned to: @thenic95
  • Constitutional Committee (CC): Introduction to its purpose and activities. -> Assigned to: @thenic95
  • Decision-Making Process: Overview of governance actions, detailing the process from proposal to decision. -> Assigned to: @thenic95

• Create an governance-actions.md file that explains the Governance Actions (Please refer to the above mentioned outline) -> Assigned to: @thenic95

Governance Tutorials

• Create Sub-Category "Governance Tutorials" within the category "Cardano Governance" -> Assigned to: @thenic95
• Create an Overview.md file explaining the intricacies of using the CLI for voting purposes. Link to install node example. Link to other governance tooling that doesn’t require the node. ->  Assigned to: @CarlosLopezDeLara
• Create tutorials-drep.md and fill it with content that was mentioned above. -> Assigned to: @CarlosLopezDeLara
• Create tutorials-spo.md and fill it with content that was mentioned above. -> Assigned to: @CarlosLopezDeLara
• Create tutorials-cc.md and fill it with content that was mentioned above. -> Assigned to: @CarlosLopezDeLara
• Create tutorials-ada-holder.md and fill it with content that was mentioned above. -> Assigned to: @CarlosLopezDeLara

3. External Contributions

• Develop and publish Contribution Guidelines. -> Assigned to: @thenic95
• Launch a call for contributions via community channels. -> Assigned to: @thenic95

4. Review and Quality Control

• Implement a peer-review process for all new content. -> Assigned to: @thenic95

5. Launch

• Prepare the website for the launch of the new section. -> Assigned to: TBD
• Announce the launch through various channels. -> Assigned to: TBD

Stakeholders

• Nicolas Cerny (CF)

---

Contribution Guidelines

Thank you for your interest in contributing to the governance section revamp! We value your contributions and aim to make this process as smooth as possible. Here are some steps and guidelines to follow:

Expressing Interest

• Identify a Task: Review the project plan and tasks listed. If you're interested in a specific section or task and no one has been assigned yet, please proceed to the next step.
• Voice Your Interest: Please leave a comment on this issue indicating the task or section you'd like to work on. This helps us keep track of all interests and avoid overlaps.

Collaboration

• Team Up: If a task has already caught someone's eye, and you're interested in collaborating, tag them in a comment expressing your interest in collaborating. Collaboration is highly encouraged, as it brings diverse perspectives and expertise.
• Assignments: Tag @thenic95 and tell him about your interest. He will respond to your comment, confirming your assignment to the task or facilitating the collaboration with the existing contributor.

Guidelines for Contributions

• Adherence to Standards: Please ensure your contribution adheres to the outlined Developer Portal Style Guide, which can be found here. This includes style, tone, and content structure.
• Submission Process: After completing your contribution, submit it via a pull request to the governance-revamp branch. Please include a brief description of your changes and any other relevant information.
• Review Process: Your submission will undergo a peer review by one of our team members or designated reviewers. Feedback will be provided if adjustments are needed. Once approved, it will be merged into the project.

Open Communication

• Questions and Discussions: If you have any questions or wish to discuss ideas and suggestions, feel free to start a discussion in this issue thread. Open communication is crucial to the success of this project.

Acknowledgment

• Credit: Contributors will be acknowledged for their work in the final section's release notes and on the Developer Portal Changelog.

We appreciate your contributions to making the governance section more informative and up-to-date. Your expertise and effort play a crucial role in the success of this project. Let's collaborate to make this a valuable resource for everyone involved with the project.

Feedback

Please direct any feedback or suggestions here in this GitHub issue.

[katomm]

Great issue. We should have the counterpart of this issue on https://github.com/cardano-foundation/cardano-org so that we can divide the more technical content and revamp the content on https://cardano.org/governance/

[thenic95]

I had a great chat with @CarlosLopezDeLara , who showed me the cardano-cli documentation he's working on for the Dev Portal. Since he will include governance-related tutorials, it makes more sense to remove the tutorials from the revamped governance sections and link to the new cardano-cli section that Carlos will introduce.