Skip to content

Commit

Permalink
docs: update getting-started guide (#149)
Browse files Browse the repository at this point in the history
Signed-off-by: Panos Vagenas <35837085+vagenas@users.noreply.github.com>
  • Loading branch information
vagenas committed Jan 3, 2024
1 parent 9c7d500 commit 277448a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 25 deletions.
31 changes: 6 additions & 25 deletions docs/getting_started/index.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,12 @@
### Get your credentials
### Set up your profile

After registering with [Deep Search](https://ds4sd.github.io/), you can obtain your authentication data by clicking on "API" in the top-right corner. Your credentials consist of your `User name` and your `API key`.
After logging in to the Deep Search UI, you can set up your profile as shown below:

![Deep Search Authentication Info](../images/deepsearch-auth-info.png)


---
### Set up a profile

=== "CLI"
Set up a [profile][profiles] using `deepsearch profile config`.
In its basic form it looks like this:
<div class="termy">
1. click on the "Toolkit / API" icon on the top-right corner
2. from the "Toolkit" section, copy the command and run on your terminal
3. when prompted for the API key, copy it from the "HTTP" section

```console
$ deepsearch profile config
Host: https://ds.example.com # the Deep Search instance you are using
Username: name@example.com # your username
Api key: (hidden) # your API key
```

</div>

By providing a profile name (via option `--profile-name`) you can configure multiple
different profiles, which you can then easily switch between and manage.

For details, check [Profiles][profiles].
![Deep Search Authentication Info](../images/deepsearch-auth-info.png)

### Validate the setup

Expand Down
Binary file modified docs/images/deepsearch-auth-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 277448a

Please sign in to comment.