Skip to content

Commit

Permalink
Merge pull request #898 from gardenenigma/main
Browse files Browse the repository at this point in the history
Update to the docs
  • Loading branch information
GlenWeyl authored Apr 22, 2024
2 parents 99c678c + 23e0df6 commit 380dbcf
Show file tree
Hide file tree
Showing 27 changed files with 513 additions and 205 deletions.
11 changes: 11 additions & 0 deletions docs/Contributing citations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Contributing citations
author:
date:
tags:
-
---

# Contributing citations and references

> Brief info about contributing citations and references
11 changes: 11 additions & 0 deletions docs/Contributing content and edits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Contributing content and edits
author:
date:
tags:
-
---

# Contributing content and edits

> Brief info about contributing edits
8 changes: 7 additions & 1 deletion docs/Contributing figures.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
---
Title: Contributing figures
author:
date:
tags:
-
---

# Contributing figures
# Contributing figures

> Brief overview of contriuting figures
33 changes: 33 additions & 0 deletions docs/Contributing getting started as a contributor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
Title: Getting started as a contributor
author:
date:
tags:
-
---

# Getting started as a contributor

> While this project will begin as a traditional open-source community, we eventually hope to provide more formal governance, participation, control rights and recognition of contributions than has been customary in such projects.
We believe such features are important for open-source projects like this one to sustainably scale while staying true to their values. As such, a primary goal of our management of this project will be to clearly and (for the most part) publicly recognize contributions with both qualitative (viz. what kind of contribution was made) and quantitative (viz. how important was the contribution) tokens.

However, these tokens cannot be traded/transferred directly across users; they are relevant only to governance of and participation in this community and are not intended to have any external financial value, except through the value of the community as a whole. We may raise some funds to support the community and the community will govern these funds. However, credit is a marker of contribution and entitlement to governance, not to direct external financial gain.
Contributions will be of many kinds.

## Potential ways to contribute

While we cannot hope to anticipate them all types of contributions, here is a short sampling that provides a sense for the range we expect:

* Translations of the book to other languages and subcultures.
* Research assistance for and editing of the root text.
* Thoughtful and accurate prioritization of issues and pull requests.
* Contributing to or helping maintain the website interface for the book.
* Graphical design of elements of the book, including visual contributions and figures.
* Managing data engines and data visualization.
* Project management of interaction of these elements
* Contributing to the tools and platforms that support the collaborative process.

Quality of contributions and thus quantity of recognition will largely (with some exceptions discussed below) begin as a discretionary choice of the maintainers. However, we eventually hope to transition an increasing range of the mechanisms through which we give out such recognition to formal community governance, as part of the governance and progressive decentralization below.

All identity roles and credit will initially be public (possibly pseudonymous, but with no internal privacy controls). We hope to introduce some innovative privacy features consistent with the ideas in the book (such as designated verifier signatures) in the future.
11 changes: 11 additions & 0 deletions docs/Contributing in other ways.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Contributing citations
author:
date:
tags:
-
---

# Contributing in other ways

> Brief info about contributing in other ways
11 changes: 11 additions & 0 deletions docs/Contributing to the docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Contributing citations
author:
date:
tags:
-
---

# Contributing to the docs

> Brief info about contributing to the docs
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
---
title: Contributing translations
author:
date:
tags:
-
---

# Plurality Translation Contributor Onboarding
# Contributing translations

>👋 Welcome! This document aims to help onboard new contributors from different regional communities to help translate the Plurality book.
Expand All @@ -20,14 +24,14 @@ Is there a point of contact or thread already for your language / region?

* if yes, please find them in [#translations](https://discord.gg/9x3nBJeuPY), reach out to them in your community’s thread
* if no, tag Jacky in #general under Contributors to get onboarded
![discord screenshot of translations tab](../assets/translation-screenshot-01.png)
![discord screenshot of translations tab](assets/translation-screenshot-01.png)

## Translation Process

> *Reach out to Jacky if there are any questions here*
* English and Traditional Mandarin are considered the root language that will be directly uploaded to the root repository. Translations of other languages will need to be done in forks from the root to decentralize and streamline each community’s independent workflow.
![translation git repos](../assets/translation-screenshot-02.png)
![translation git repos](assets/translation-screenshot-02.png)

* The point of contact for each community can fork the main branch of [plurality root repository](https://github.com/pluralitybook/plurality) on GitHub and start adding their translated content in the forked repository.
* please name the fork with book name + language name for easier recognizability (e.g plurality-japanese)
Expand All @@ -38,17 +42,17 @@ Is there a point of contact or thread already for your language / region?
> *Reach out to Aki or Jacky if there are any questions here. Many steps are still quite manual, the process should become easier as more people go through them.*
* Start with translating the announcement if its not already translated, and submit it to be added under the different versions of the [announcement in GitHub](https://github.com/alexrandaccio/plurality.net/tree/main/src/site/versions).
![alt text](../assets/translation-screenshot-03.png)
![alt text](assets/translation-screenshot-03.png)

* Add translated chapters in your forked repository with English file names
* Create a pull request on https://github.com/alexrandaccio/plurality.net using same structure as https://github.com/alexrandaccio/plurality.net/pull/14/files to add new chapters [here](https://github.com/alexrandaccio/plurality.net/tree/main/src/site/chapterversions)

![alt text](../assets/translation-screenshot-04.png)
![alt text](../assets/translation-screenshot-05.png)
![alt text](assets/translation-screenshot-04.png)
![alt text](assets/translation-screenshot-05.png)

* Aki will approve incoming pull requests in order for the content to be shown on the website

### References
## References

> Feel free to ask any questions in Discord under **Contributors** category
Expand Down
6 changes: 0 additions & 6 deletions docs/Getting started as a contributor.md

This file was deleted.

4 changes: 4 additions & 0 deletions docs/Gov4Git and PMP.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
---
title: Gov4Git and PMP
author:
date:
tags:
-
---

# ⿻ Plural Management of ⿻ 數位 Plurality
Expand Down
16 changes: 16 additions & 0 deletions docs/Governance Gov4Git.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
Title: Gov4Git
author:
date:
tags:
-
---
# Gov4Git and PMP

## Gov4Git

> [Gov4Git](https://gov4git.org/) (G4G) is an open-source protocol that uses a blockchain-like structure where a ledger of credits is mirrored by the Git repositories of all its members.
In contrast to standard blockchains G4G does not include financial incentives for maintenance of the ledger and instead relies on community members to mirror the underlying database for the same reason that they mirror the code of git projects (to participate in the community).

When there is a conflict in the ledger, the governance procedures described below work to resolve these conflicts. The social capitalization table used for allocating PCs will live on a ledger that is maintained by the community through the Gov4Git protocol.
23 changes: 23 additions & 0 deletions docs/Governance PMP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
Title: Governance PMP
author:
date:
tags:
-
---

# Plural Management Protocol

> While the Gov4Git protocol offers a foundational layer for an essentially-arbitrary range of governance mechanics, the governance mechanism that we plan to implement is the Plural Management Protocol (PMP).
The PMP harnesses and combines a range of the mechanisms described in the book to allow us to achieve our goals. Full details of the PMP can be found in the [Plural Management paper](https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4688040).

With the PMP, contributors can earn credits by making contributions to the book (approval of the contributors GitHub pull requests), and by helping others triage pull requests (predicting the outcome of a pull request approval vote). Contributors can then use their credits to prioritize GitHub issues, and to approve or reject GitHub pull requests.

## Processes of the PMP

1. **Prioritization**: Issues are prioritized by a version of the Capital-Constrained [Quadratic Funding](https://arxiv.org/abs/1809.06421) (QF) mechanism. Contributors dynamically contribute to proposals’ priorities and are matched according to the “democratic” QF formula (e.g. small contributions are matched more than large ones, and contributions to popular issues are matched more) and the current matching funds made available by sponsors.
2. **Subsidies**: The matching funds are provided by sponsors, mostly likely the largest PC holders such as E. Glen Weyl and Audrey Tang.
3. **Bounties and contributions**: The current priorities of issues are publicly displayed and ranked, so as to encourage contributors to prioritize addressing these. A contributor who submits a PR to address an issue and has this PR accepted will receive a bounty in PCs Plural Management user doc.docx proportional to this current priority (with a small “tax” to support the process of evaluating the PR).
4. **Approval votes**: Contributors can vote for a PR to be accepted or rejected. PRs with net positive votes at the end of the review period (currently a week) will be accepted. The cost in credits of $v$ votes is $kv^2$ where $k$ is a PR-specific constant. This instantiates the system of [Quadratic Voting](https://en.wikipedia.org/wiki/Quadratic_voting#:~:text=With%20quadratic%20voting%2C%20not%20only,be%20%244%2C%20and%20so%20on.) (QV) described in the book.
5. **Approval predictions**: In addition to voting, contributors are also implicitly predicting what decision the community will make; in addition to the cost of $kv^2$ they will also pay a cost of $|v|$ and receive a payment of $2|v|$ if the community decides in favor of the direction of their vote. For someone who is purely maximizing their return, it is optimal to vote in the amount $\frac{|p-1/2|}{2k}$ in the direction that they believe it is more likely for the vote to go, where $p$ is the probability they believe the vote will be approved. This provides low PC-holding community members to gain PCs by helping those who may have more PCs but less time to review submissions to sort the wheat from the chaff.
22 changes: 22 additions & 0 deletions docs/Governance introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Governance introduction
author:
date:
tags:
-
---

# Governance introduction

> The ideas described in Plurality aim to tell the world how collaborative technology can remake how we work and govern together. The Plurality community also aims show how these ideas can work in practice.
To do this, the Plurality book will be built using the principles that are described in the book. This is a challenge because it is a book about innovation and thus the platforms for the things we want to show do not exist: we are building them as we go in the process of writing the book!

## Governance goals

We have several interlocking goals in the design of our management system:

1. **We want to recognize project contributions formally, quantitatively, and democratically.** This can be contrasted to the informal and often confusing methods that are typical to open-source projects.
2. **We want to avoid speculation and financialization** of the devices that will be used to recognize contributions to the project.
3. **We want to demonstrate the ideas of Plurality.** To do this, we will aim to ensure that the direction of the project is determined democratically. Eventually, we want to turn over the maintenance of the project to the community completely.
4. **We want the project to scale smoothly while also ensuring that the systems we use are secured against malicious attacks.** We want to ensure that democratization and decentralization happens gradually and does not occur at the expensive of the integrity of the project’s contents or the community’s values.
24 changes: 24 additions & 0 deletions docs/Governance plural credits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
Title: Governance plural credits
author:
date:
tags:
-
---

# Plural Credits

> A key device that will be used by the community to accomplish our [governance goals](Governance introduction.md) is a system of unique credits we call Plural Credits.
Plural credits (PCs) are used to formally recognize when someone contributes to the project. PCs will initially be interchangeable, quantitative, and divisible indicators of contribution. Individuals will not be able to transfer or sell credits to one another. While of no (direct) financial value, PCs will entitle holders to several social benefits.

## Benefits of Plural Credits

1. **Recognition**: Our ledger of PC holdings will be the definitive source of information on the contributions to the book. We plan to display the ledger in in several ways. One of these ways could be to create collective image that acts as a “credit scroll” of contributors. The more significant one’s contribution is to the project, the more prominently they will be displayed in this image. Whenever we refer to the “⿻ community”, we will implicitly be referencing this ledger.
2. **Governance rights**: PCs will be the tool that is used to govern the project. They govern by determining the priority of work, and the changes or contributions that should be accepted. When PCs are used for governance, they also determine who will receive PCs in the future and thus who will be able to make further governance decisions. More on governance is discussed below.
3. **Resources**: PCs will gate access to various resources. This includes ‘@plurality.net’ email addresses, GitHub Pro coupons, and other benefits (including possibly financial compensation from funds raised by book sales, all of which will be donated to the community’s collective governance). Resources will be voted on by the community and will remain consistent with our status as being fiscally sponsored by the charitable organisation (US 501c3) Open Collective Foundation. Any compensation is to be reasonable, transparent, and consistent with this status.
After introduction of quantitative PCs we plan to introduce qualitative tokens. Qualitative tokens will be able to indicate the type of contribution that an individual makes (e.g. a written, design, or technical contribution).

## Social capitalization table

We will shortly release a “social capitalization table” that will make the allocation of PCs now and in the short term more clear. Future evolution of the social capitalization table will be determined collectively by the community. The social capitalization table will initially be released as a simple spreadsheet, however it will eventually live in a distributed ledger maintained by the community through the open source Gov4Git (G4G) protocol.
31 changes: 31 additions & 0 deletions docs/Home citing the book.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Citing the book
author:
date:
tags:
-
---

# Citing the book

> Citing the book promotes its recognition, increasing chances for collaboration and thus the inclusivity and sustainability of the project.
Feel free to copy the citation samples below if you would like to cite the book.

## Chicago citation sample

```
Weyl, E. Glen, Audrey Tang, and the Plurality Community. "Plurality: The Future of Collaborative Technology and Democracy." 2023. GitHub. Accessed [Date accessed]. https://github.com/pluralitybook/plurality/blob/main/contents/english.
```

## BibTeX sample

```
@online{plurality2023,
title={Plurality: The Future of Collaborative Technology and Democracy},
author={Weyl, E. Glen and Tang, Audrey and {the Plurality Community}},
year={2023},
url={https://github.com/pluralitybook/plurality/blob/main/contents/english},
publisher={GitHub},
}
```
14 changes: 14 additions & 0 deletions docs/Home copyright.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title:
author:
date:
tags:
-
---
# Copyright

> All materials in this repo and in all other parts of this project (unless explicitly stated otherwise) are in the public domain
>
> A CC0 license can be found in the [project's repository](https://github.com/pluralitybook/plurality/blob/08ed3dff4071905bf2f741ec55b09127d340db87/LICENSE), and most of the related software has a [GNU General Public License](https://en.wikipedia.org/wiki/GNU_General_Public_License).
We strongly encourage translations, both to other languages and to other cultural genres, whether in terms of formatting (fiction, journalism, etc.) or to different communities (religious, ethnic, disciplinary, etc.). While these "forks" can do whatever they wish with this public domain material, we plan to link to and "recognize" only a smaller group of projects that align to the root in terms of content, values, management style and copyrights. We hope this link and roots will remain relevant and respected because of the legitimacy this community will achieve through its principles and writing.
17 changes: 17 additions & 0 deletions docs/Home editing and pull requests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title:
author:
date:
tags:
-
---

# Editing and pull requests

> While there will be many types of contributions, arguably the focal and most common one will be editing of the root book.
This will happen through the standard git issue-fork-pull request-merge process which we will not discuss further here, as it is well documented in many places online. As such, several central sources of credit and contribution will be related to this process and they are worth discussing in a bit greater detail here.

In writing this book, we aim to create a new vision for the future of technology that can help inspire a community to pursue and help create it. We do not aim primarily at a statement of fact or consensus, though we hope to help surface facts and promote cooperation across difference. As such, we will strive to mostly maintain a coherent argument and authorial voice, rather than combining together separate contributions from distinct authors. However, we believe such a goal is consistent with a wide range of participation and input and that, ultimately, our ideas will only succeed if they eventually become a reflection of common sense of a community that pursues them. As such we hope that the community helping us build this book will contribute a range of edits from the small (e.g. copyedits) to the large (e.g. building blocks of text that help us flesh out an application or restate a principle). The more significant these contributions, the greater they will be recognized. We also seek to embrace technological advancements in all our work and thus welcome the use of a range of digital assistive tools, such as generative foundation models, in creating contributions.

At the same time, we expect there to be far more engagement than any small group of maintainers can realistically manage in any project on these terms, especially one as ours that has natural adversaries. Thus the editorial and maintenance role will be at least as important for us to share with the community as the contribution role. We plan to do this by asking the community to help prioritize issues and PRs and to reward accurate prioritization, ones that end up being accepted/acted upon. The precise mechanisms we will use for this will evolve over time and we will shortly link to live explanatory documents. However, we will always endeavor to use creative approaches grounded in the principles described in the book, for example using a mixture of prediction markets and various forms of plural voting.
Loading

0 comments on commit 380dbcf

Please sign in to comment.