Merge pull request #514 from docker/feat/docs

feat(pass): documentation

Author: joe0BAB

plugins/pass/commands/rm.go

@@ -38,13 +38,13 @@ func RmCommand(kc store.Store) *cobra.Command {
 		Aliases: []string{"delete", "erase", "remove"},
 		Short:   "Remove secrets from local keychain.",
 		Long:    "Removes one or more named secrets from the local OS keychain.\nUse --all to remove every stored secret at once.",
-		Example: `# Remove a specific secret:
+		Example: `### Remove a specific secret:
 docker pass rm GH_TOKEN
 
-# Remove multiple secrets:
+### Remove multiple secrets:
 docker pass rm GH_TOKEN NPM_TOKEN
 
-# Remove all secrets:
+### Remove all secrets:
 docker pass rm --all`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			idList, err := validateArgs(args, opts)

plugins/pass/commands/set.go

@@ -30,17 +30,17 @@ import (
 )
 
 const setExample = `
-# Set a secret:
+### Set a secret:
 docker pass set POSTGRES_PASSWORD=my-secret-password
 
-# Or pass the secret via STDIN:
+### Or pass the secret via STDIN:
 echo my-secret-password > pwd.txt
 cat pwd.txt | docker pass set POSTGRES_PASSWORD
 
-# Set a secret with metadata:
+### Set a secret with metadata:
 docker pass set POSTGRES_PASSWORD=my-secret-password --metadata owner=alice --metadata expiry=2027-03-01
 
-# Or pass a JSON payload with secret and metadata via STDIN:
+### Or pass a JSON payload with secret and metadata via STDIN:
 echo '{"secret":"my-secret-password","metadata":{"owner":"alice"}}' | docker pass set POSTGRES_PASSWORD
 `