Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update getting-started guide #149

Merged
merged 1 commit into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.