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
diff --git a/docs/en/client.md b/docs/en/client.md
0new file mode 1006440new file mode 100644
index 0000000..a1cfc9e
--- /dev/null
+++ b/docs/en/client.md
@@ -0,0 +1,36 @@
1---
2title: Client
3---
4
5Installation
6============
7
8The snapstore client can be installed from the snap store:
9
10 snap install snapstore-client
11
12Configuration
13=============
14
15The client requires an admin user to be registered in the Snap Enterprise Proxy
16before it can perform any operations. This user must be registered with
17the [Ubuntu SSO provider](https://login.ubuntu.com).
18
19From the command line on the machine that has the Proxy installed, run:
20
21 sudo snapstore add-admin becky@example.com
22
23Once the user has been registered, the client can login:
24
25 snapstore-client login
26
27Usage
28=====
29
30snapstore-client provides the same command line interface for managing overrides
31as the CLI client installed with the Proxy. It cannot configure any system
32settings for the Proxy.
33
34 snapstore-client list-overrides
35 snapstore-client override foo stable=10
36 snapstore-client delete-override foo
diff --git a/docs/en/index.md b/docs/en/index.md
index fe54667..b84c749 100644
--- a/docs/en/index.md
+++ b/docs/en/index.md
@@ -2,11 +2,14 @@
2title: Index2title: Index
3---3---
44
5Snap Store Proxy API Documentation5Snap Enterprise Proxy API Documentation
6=================================6=================================
77
8This is the documentation for the snap store proxy, which allows you to override8This is the documentation for the Snap Enterprise Proxy API,
9upstream revisions for specific snaps on your snap store proxy.9which allows you to override upstream revisions for specific snaps
10on your instance of the proxy.
11It also includes documentation on the command line client (snapstore-client).
1012
11* [Authentication](authentication.html)13* [Authentication](authentication.html)
12* [Overrides](overrides.html)14* [Overrides](overrides.html)
15* [Client](client.html)

Subscribers

People subscribed via source and target branches

to all changes: