Merge ~twom/snapstore-client:add-docs-on-client into snapstore-client:master

Proposed by Tom Wardill
Status: Merged
Approved by: Tom Wardill
Approved revision: 7624f765a29e2e334e0b85a97c5f4505881671d9
Merge reported by: Otto Co-Pilot
Merged at revision: not available
Proposed branch: ~twom/snapstore-client:add-docs-on-client
Merge into: snapstore-client:master
Diff against target: 64 lines (+42/-3)
2 files modified
docs/en/client.md (+36/-0)
docs/en/index.md (+6/-3)
Reviewer Review Type Date Requested Status
Adam Collard (community) Approve
Review via email: mp+342081@code.launchpad.net

Commit message

Add basic documentation for client configuration and usage.

Description of the change

Add basic documentation for client configuration and usage.

To post a comment you must log in.
Revision history for this message
Colin Watson (cjwatson) :
Revision history for this message
Tom Wardill (twom) :
7624f76... by Tom Wardill

Fix typo

Revision history for this message
Adam Collard (adam-collard) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/docs/en/client.md b/docs/en/client.md
2new file mode 100644
3index 0000000..a1cfc9e
4--- /dev/null
5+++ b/docs/en/client.md
6@@ -0,0 +1,36 @@
7+---
8+title: Client
9+---
10+
11+Installation
12+============
13+
14+The snapstore client can be installed from the snap store:
15+
16+ snap install snapstore-client
17+
18+Configuration
19+=============
20+
21+The client requires an admin user to be registered in the Snap Enterprise Proxy
22+before it can perform any operations. This user must be registered with
23+the [Ubuntu SSO provider](https://login.ubuntu.com).
24+
25+From the command line on the machine that has the Proxy installed, run:
26+
27+ sudo snapstore add-admin becky@example.com
28+
29+Once the user has been registered, the client can login:
30+
31+ snapstore-client login
32+
33+Usage
34+=====
35+
36+snapstore-client provides the same command line interface for managing overrides
37+as the CLI client installed with the Proxy. It cannot configure any system
38+settings for the Proxy.
39+
40+ snapstore-client list-overrides
41+ snapstore-client override foo stable=10
42+ snapstore-client delete-override foo
43diff --git a/docs/en/index.md b/docs/en/index.md
44index fe54667..b84c749 100644
45--- a/docs/en/index.md
46+++ b/docs/en/index.md
47@@ -2,11 +2,14 @@
48 title: Index
49 ---
50
51-Snap Store Proxy API Documentation
52+Snap Enterprise Proxy API Documentation
53 =================================
54
55-This is the documentation for the snap store proxy, which allows you to override
56-upstream revisions for specific snaps on your snap store proxy.
57+This is the documentation for the Snap Enterprise Proxy API,
58+which allows you to override upstream revisions for specific snaps
59+on your instance of the proxy.
60+It also includes documentation on the command line client (snapstore-client).
61
62 * [Authentication](authentication.html)
63 * [Overrides](overrides.html)
64+* [Client](client.html)

Subscribers

People subscribed via source and target branches

to all changes: