Skip to content

Commit 3aa9790

Browse files
committed
___ wip: update documentation
1 parent c232c2d commit 3aa9790

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

docs/features.rst

+23-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,29 @@ FIXME).
1919
Authentication
2020
--------------
2121

22-
FIXME
22+
**Cogite** uses the HTTP API of the Git host to create pull requests
23+
and, more generally, retrieve information from the host. For this to
24+
work, it needs to authenticate itself. You need only do so once for
25+
each host.
26+
27+
There are two ways to authenticate:
28+
29+
- Use the default, guided, semi-automatic mechanism (known as "OAuth
30+
device flow" or "OAuth Device Authorization Grant") that defines a
31+
new, properly configured authentication token that you can revoke at
32+
any time. Basically, **Cogite** will display a one-time verification
33+
code and open a browser window for you, where you can enter this
34+
code to validate your token on the requested Git host.
35+
36+
FIXME: include screencast
37+
38+
- If you already have a properly configured authentication token, or
39+
if you don't trust **Cogite** mechanism above, you can use your own
40+
authentication token. It MUST grant the "repo" scope. It is probably
41+
a good idea to define a specific token for **Cogite** instead of
42+
re-using the same token for many applications. That way, you can
43+
revoke the token of a single application without affecting other
44+
applications.
2345

2446

2547
.. _features_merge:

docs/getting_started.rst

-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ Minimal configuration
3030

3131
2. Run ``cogite auth add`` and follow instructions.
3232

33-
FIXME: explain the two current options : manual token or automatic configuration.
34-
3533
For further details about authentication-related commands, see
3634
:ref:`features_authentication` and :ref:`commands_auth`.
3735

0 commit comments

Comments
 (0)