Merge pull request #1629 from julian-molina/develop

Contribution: Governance workspaces WIP
2021-09-02 13:24:08 +02:00
commit fa862c915d
@@ -22,8 +22,13 @@
        },
        {
            "style": "Chapter",
-            "text": "IV->Governance->Topic->Governance Flow->The Superalgos Governance Project implements a meritocratic system, by which the more you contribute, the more you are entitled to influence the direction of development. ",
-            "updated": 1624782801597
+            "text": "IV->Governance->Topic->Governance Flow->The Superalgos Governance Project implements a meritocratic system, by which the more you contribute, the more you are entitled to influence the direction of development.",
+            "updated": 1630576718872
+        },
+        {
+            "style": "Chapter",
+            "text": "V->Governance->Topic->Governance Workspaces->The Governance Project features multiple Project Definition Hierarchies spread across multiple Plugin Workspaces — one Workspace per Project — to facilitate the granular management of definitions by independent teams of maintainers. These are the Governance Workspaces.",
+            "updated": 1630576758374
        }
    ]
 }
@@ -1,8 +1,8 @@
 {
    "type": "Distribution Event",
    "definition": {
-        "text": "The Superalgos Project distributes its native Superalgos SA Tokens after each release to compensate contributions and incentivize desirable behaviors. The Distribution Event represents the moment in time and the act of running the process that distributes tokens from the Treasury Account to the Governance Address associated with each User Profile that participates in governance.",
-        "updated": 1630234849482
+        "text": "The Superalgos Project distributes its native Superalgos SA Tokens after each release to reward contributions and incentivize desirable behaviors. The Distribution Event represents the moment in time and the act of running the process that distributes tokens from the Treasury Account to the Governance Address associated with each User Profile that participates in governance.",
+        "updated": 1630570602251
    },
    "paragraphs": [
        {
@@ -9,27 +9,71 @@
            "style": "Title",
            "text": "Computational Limitations"
        },
-        {
-            "style": "Block",
-            "text": "Computational Limitations"
-        },
        {
            "style": "Title",
            "text": ""
        },
        {
-            "style": "Note",
+            "style": "Block",
+            "text": "Computational Limitations",
+            "updated": 1630569942063
+        },
+        {
+            "style": "Text",
            "text": "The governance system does all calculations dynamically, in real-time, with every change in the definitions, and computes all the hierarchies loaded in the Current Workspace."
        },
        {
            "style": "Important",
            "text": "The above means that the calculations that you see from within any given Workspace is a partial calculation within the scope of the Current Workspace only. Definitions, claims, votes, and so on, existing on other workspaces or plugins are not computed."
        },
+        {
+            "style": "Block",
+            "text": "Computational Limitations 2",
+            "updated": 1630569818098
+        },
+        {
+            "style": "Text",
+            "text": "If you cast votes or place claims in more than one Governance Workspace, you will not be able to see what some of your claims and votes are about — in particular, those that live on a workspace that is not the Current Workspace.",
+            "updated": 1630569998640
+        },
+        {
+            "style": "Text",
+            "text": "If you wish to have a clearer picture of all your votes and claims, you may want to set up a new workspace that includes all the hierarchies that you need to interact with. That way, you will be able to see all of your votes and claims at the same time. To do this, save a new workspace deriving from one of the Governance Workspaces and load the plugins you need.",
+            "updated": 1630570350637
+        },
+        {
+            "style": "Note",
+            "text": "Even if you do as suggested above, the calculations you see in terms of Token Rewards, Tokens Awarded, Tokens Bonus, and so on, are still partial. The actual Distribution Event calculation involves computing all of the Project Definition Hierarchies, including all User Profile hierarchies participating in governance.",
+            "updated": 1630570663757
+        },
+        {
+            "style": "Text",
+            "text": ""
+        },
        {
            "style": "Block",
            "text": "Dummy",
            "updated": 1630230740442
        },
+        {
+            "style": "Title",
+            "text": "Deep in Governance",
+            "updated": 1630574167914
+        },
+        {
+            "style": "Block",
+            "text": "Deep in Governance"
+        },
+        {
+            "style": "Success",
+            "text": "If you have contributed work or wish to go deep with your participation in governance, you will most likely need to interact with one or more of the project-specific Governance Workspaces. To do that, load your User Profile into the corresponding workspaces so that you may establish references to place Contribution Claims and cast Weight Votes.",
+            "updated": 1630574190576
+        },
+        {
+            "style": "Block",
+            "text": "Dummy",
+            "updated": 1630574197424
+        },
        {
            "style": "Title",
            "text": "Featuring Tokens Bonus"
@@ -12,7 +12,7 @@
        },
        {
            "style": "Text",
-            "text": "Because this is the highest level definition of how tokens will be distributed, the Superalgos Pools hierarchy is present in all Governance Plugin Workspaces.",
+            "text": "Because this is the highest level definition of how tokens will be distributed, the Superalgos Pools hierarchy is present in all Governance Workspaces.",
            "updated": 1630426648511
        },
        {
@@ -14,6 +14,18 @@
            "style": "Include",
            "text": "Governance->Concept->Reusable Governance Snippets->Claim Votes Content"
        },
+        {
+            "style": "Subtitle",
+            "text": "Working on Multiple Workspaces"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Deep in Governance"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Computational Limitations 2"
+        },
        {
            "style": "Block",
            "text": "Configuration"
@@ -14,6 +14,18 @@
            "style": "Include",
            "text": "Governance->Concept->Weight Votes->Content"
        },
+        {
+            "style": "Subtitle",
+            "text": "Working on Multiple Workspaces"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Deep in Governance"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Computational Limitations 2"
+        },
        {
            "style": "Block",
            "text": "Configuration"
@@ -14,6 +14,26 @@
            "style": "Include",
            "text": "Governance->Concept->Reusable Governance Snippets->Claim Votes Content"
        },
+        {
+            "style": "Subtitle",
+            "text": "Working on Multiple Workspaces"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Deep in Governance"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Computational Limitations 2"
+        },
+        {
+            "style": "Subtitle",
+            "text": ""
+        },
+        {
+            "style": "Text",
+            "text": ""
+        },
        {
            "style": "Block",
            "text": "Configuration"
@@ -14,6 +14,18 @@
            "style": "Include",
            "text": "Governance->Concept->Weight Votes->Content"
        },
+        {
+            "style": "Subtitle",
+            "text": "Working on Multiple Workspaces"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Deep in Governance"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Computational Limitations 2"
+        },
        {
            "style": "Block",
            "text": "Configuration"
@@ -29,7 +29,7 @@
        },
        {
            "style": "Text",
-            "text": "In addition, there is a third resource characteristic to the Pool Hierarchy. Each Pool may reference a separate Pools hierarchy so that the definitions may continue on a separate hierarchy, which may be included as a plugin in the same or in separate Governance Plugin Workspaces.",
+            "text": "In addition, there is a third resource characteristic to the Pool Hierarchy. Each Pool may reference a separate Pools hierarchy so that the definitions may continue on a separate hierarchy, which may be included as a plugin in the same or in separate Governance Workspaces.",
            "updated": 1630426515819
        },
        {
@@ -15,6 +15,18 @@
            "text": "Governance->Concept->Reusable Governance Snippets->Claim Votes Content",
            "updated": 1630350813522
        },
+        {
+            "style": "Subtitle",
+            "text": "Working on Multiple Workspaces"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Deep in Governance"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Computational Limitations 2"
+        },
        {
            "style": "Block",
            "text": "Configuration"
@@ -14,6 +14,18 @@
            "style": "Include",
            "text": "Governance->Concept->Weight Votes->Content"
        },
+        {
+            "style": "Subtitle",
+            "text": "Working on Multiple Workspaces"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Deep in Governance"
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Computational Limitations 2"
+        },
        {
            "style": "Block",
            "text": "Configuration"
@@ -0,0 +1,85 @@
+{
+    "topic": "Governance Workspaces",
+    "pageNumber": "1",
+    "type": "Governance Workspaces",
+    "definition": {
+        "text": "The Governance Project features multiple Project Definition Hierarchies spread across multiple Plugin Workspaces — one Workspace per Project — to facilitate the granular management of definitions by independent teams of maintainers. These are the Governance Workspaces.",
+        "updated": 1630567756861
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "Main Governance Workspace",
+            "updated": 1630568120363
+        },
+        {
+            "style": "Text",
+            "text": "The Token Distribution Superalgos Governance Workspace is the main workspace. Load this workspace to start your interaction with governance. This is where you would usually build and set up your User Profile.",
+            "updated": 1630568963531
+        },
+        {
+            "style": "Title",
+            "text": "Naming Convention"
+        },
+        {
+            "style": "Text",
+            "text": "All Governance Workspaces follow a similar naming structure, to make them easy to spot in the Workspaces Tab:"
+        },
+        {
+            "style": "Json",
+            "text": "Token Distribution XXX Project",
+            "updated": 1630568716919
+        },
+        {
+            "style": "Note",
+            "text": "XXX is replaced with the actual name of the Project.",
+            "updated": 1630568059149
+        },
+        {
+            "style": "Title",
+            "text": "Finding Your Way Arround Governance Workspaces",
+            "updated": 1630568467050
+        },
+        {
+            "style": "Text",
+            "text": "Each of the Governance Workspaces features several Project Definition Hierarchies describing the Pools, Assets, Features, and Positions of the corresponding Project.",
+            "updated": 1630568821141
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Deep in Governance"
+        },
+        {
+            "style": "Text",
+            "text": ""
+        },
+        {
+            "style": "Title",
+            "text": "Superalgos Pools Hierarchy",
+            "updated": 1630568627153
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Superalgos Pools->Definition",
+            "updated": 1630568552530
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Superalgos Pools->Content"
+        },
+        {
+            "style": "Title",
+            "text": "Scope of Calculations",
+            "updated": 1630569279039
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Computational Limitations",
+            "updated": 1630569313627
+        },
+        {
+            "style": "Include",
+            "text": "Governance->Concept->Reusable Governance Snippets->Computational Limitations 2"
+        }
+    ]
+}
@@ -0,0 +1,116 @@
+{
+    "topic": "Governance Workspaces",
+    "pageNumber": "2",
+    "type": "Token Distribution Superalgos Governance Workspace",
+    "definition": {
+        "text": "This is the main governance workspace where broad Superalgos Project definitions live.",
+        "updated": 1630575735214
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "Tutorials",
+            "updated": 1630576501552
+        },
+        {
+            "style": "List",
+            "text": "Creating Your User Profile Tutorial",
+            "updated": 1630576522747
+        },
+        {
+            "style": "Title",
+            "text": "User Profiles"
+        },
+        {
+            "style": "List",
+            "text": "Profiles of Core Team members and Community Mods."
+        },
+        {
+            "style": "Title",
+            "text": "Scope of Definitions"
+        },
+        {
+            "style": "Text",
+            "text": "The workspace features definitions that span the whole Superalgos Project.",
+            "updated": 1630576025223
+        },
+        {
+            "style": "Subtitle",
+            "text": "Pools"
+        },
+        {
+            "style": "List",
+            "text": "Superalgos Pools hierarchy.",
+            "updated": 1630576375102
+        },
+        {
+            "style": "Subtitle",
+            "text": "Positions"
+        },
+        {
+            "style": "List",
+            "text": "Superalgos Marketing (project-wide marketing-related positions),",
+            "updated": 1630576292069
+        },
+        {
+            "style": "List",
+            "text": "Superalgos (project-wide positions such as Community Mods, Core Team, or Business Lead).",
+            "updated": 1630576271333
+        },
+        {
+            "style": "Subtitle",
+            "text": "Features"
+        },
+        {
+            "style": "List",
+            "text": "Superalgos (project-wide features such as the Charting Space, the Visual Designer, the Tensor Flow integration, and so on).",
+            "updated": 1630576362020
+        },
+        {
+            "style": "Subtitle",
+            "text": "Assets"
+        },
+        {
+            "style": "List",
+            "text": "Superalgos Exchanges (assets related to exchange listings),",
+            "updated": 1630576480397
+        },
+        {
+            "style": "List",
+            "text": "Superalgos Marketing (project-wide, marketing-related assets),",
+            "updated": 1630576486012
+        },
+        {
+            "style": "List",
+            "text": "Client,",
+            "updated": 1630576385365
+        },
+        {
+            "style": "List",
+            "text": "UI,",
+            "updated": 1630576390127
+        },
+        {
+            "style": "List",
+            "text": "TS,",
+            "updated": 1630576395166
+        },
+        {
+            "style": "List",
+            "text": "Docker,"
+        },
+        {
+            "style": "List",
+            "text": "Launch Scripts,"
+        },
+        {
+            "style": "List",
+            "text": "Root Directory.",
+            "updated": 1630576402835
+        },
+        {
+            "style": "Text",
+            "text": ""
+        }
+    ]
+}
@@ -0,0 +1,102 @@
+{
+    "topic": "Governance Workspaces",
+    "pageNumber": "3",
+    "type": "Other Governance Workspaces",
+    "definition": {
+        "text": "All project-specific Governance Workspaces have a similar layout, as different projects usually have the same kinds of Assets, Features, Positions, and Pools.",
+        "updated": 1630580086379
+    },
+    "paragraphs": [
+        {
+            "style": "Title",
+            "text": "User Profiles",
+            "updated": 1630580093825
+        },
+        {
+            "style": "List",
+            "text": "Core Team members only, to keep the workspaces light."
+        },
+        {
+            "style": "Title",
+            "text": "Scope of Definitions"
+        },
+        {
+            "style": "Subtitle",
+            "text": "Pools"
+        },
+        {
+            "style": "List",
+            "text": "Superalgos Pools hierarchy (present in all Governance Workspaces for usability reasons)."
+        },
+        {
+            "style": "List",
+            "text": "A project-specific Pools hierarchy (for instance, Foundation-Project or Education-Project) defining pools for the main areas of the software, including pools for assets, features, positions, bug fixes, and improvements.",
+            "updated": 1630580570265
+        },
+        {
+            "style": "List",
+            "text": "A project-specific Pools hierarchy for assets (for instance, Foundations-Project-Assets or Education-Project-Assets), providing a more granular definition of various pools for several categories of assets, such as user interface, task server, app schemas, custom code, education, multi media,, and plugins.",
+            "updated": 1630581068210
+        },
+        {
+            "style": "Subtitle",
+            "text": "Positions"
+        },
+        {
+            "style": "List",
+            "text": "A project-specific Positions hierarchy (for instance Foundation-Project or Education-Project) defining positions such as the project's lead developer or bug hunters."
+        },
+        {
+            "style": "Subtitle",
+            "text": "Features"
+        },
+        {
+            "style": "List",
+            "text": "A project-specific Features hierarchy (for instance, Foundation-Project or Education-Project) usually defining project-specific features."
+        },
+        {
+            "style": "Subtitle",
+            "text": "Assets"
+        },
+        {
+            "style": "Text",
+            "text": "Several project-specific Assets hierarchies defining multiple catetories of assets, such as:"
+        },
+        {
+            "style": "List",
+            "text": "Client,"
+        },
+        {
+            "style": "List",
+            "text": "UI,"
+        },
+        {
+            "style": "List",
+            "text": "TS,"
+        },
+        {
+            "style": "List",
+            "text": "Plugins,",
+            "updated": 1630581417046
+        },
+        {
+            "style": "List",
+            "text": "Images,",
+            "updated": 1630581424128
+        },
+        {
+            "style": "List",
+            "text": "Docs,",
+            "updated": 1630581447409
+        },
+        {
+            "style": "List",
+            "text": "App Schemas,"
+        },
+        {
+            "style": "List",
+            "text": "Custom Code",
+            "updated": 1630581460500
+        }
+    ]
+}
@@ -55,7 +55,7 @@
        },
        {
            "style": "Text",
-            "text": "Governance is defined across multiple Governance Plugin Workspaces that users may load and contribute to. These workspaces feature the definitions of several hierarchies that determine the relationship of all the concepts affecting governance.",
+            "text": "Governance is defined across multiple Governance Workspaces that users may load and contribute to. These workspaces feature the definitions of several hierarchies that determine the relationship of all the concepts affecting governance.",
            "updated": 1630424913354
        },
        {