Browse Source

Docs: commands topics

Leszek Wiesner 3 years ago
parent
commit
0223e44c1d

+ 1 - 1
distributor-node/docs/commands/dev.md

@@ -1,7 +1,7 @@
 `joystream-distributor dev`
 ===========================
 
-
+Developer utility commands
 
 * [`joystream-distributor dev:batchUpload`](#joystream-distributor-devbatchupload)
 * [`joystream-distributor dev:init`](#joystream-distributor-devinit)

+ 1 - 2
distributor-node/docs/commands/leader.md

@@ -1,8 +1,7 @@
 `joystream-distributor leader`
 ==============================
 
-Cancel pending distribution bucket operator invitation.
-  Requires distribution working group leader permissions.
+Commands for performing Distribution Working Group leader on-chain duties (like setting distribution module limits and parameters, assigning bags and buckets etc.)
 
 * [`joystream-distributor leader:cancel-invitation`](#joystream-distributor-leadercancel-invitation)
 * [`joystream-distributor leader:create-bucket`](#joystream-distributor-leadercreate-bucket)

+ 1 - 2
distributor-node/docs/commands/operator.md

@@ -1,8 +1,7 @@
 `joystream-distributor operator`
 ================================
 
-Accept pending distribution bucket operator invitation.
-  Requires the invited distribution group worker role key.
+Commands for performing node operator (Distribution Working Group worker) on-chain duties (like accepting bucket invitations, setting node metadata)
 
 * [`joystream-distributor operator:accept-invitation`](#joystream-distributor-operatoraccept-invitation)
 * [`joystream-distributor operator:set-metadata`](#joystream-distributor-operatorset-metadata)

+ 12 - 1
distributor-node/package.json

@@ -93,7 +93,18 @@
     "bin": "joystream-distributor",
     "plugins": [
       "@oclif/plugin-help"
-    ]
+    ],
+    "topics": {
+      "leader": {
+        "description": "Commands for performing Distribution Working Group leader on-chain duties (like setting distribution module limits and parameters, assigning bags and buckets etc.)"
+      },
+      "operator": {
+        "description": "Commands for performing node operator (Distribution Working Group worker) on-chain duties (like accepting bucket invitations, setting node metadata)"
+      },
+      "dev": {
+        "description":"Developer utility commands"
+      }
+    }
   },
   "repository": {
     "type": "git",