Skip to content

Commit

Permalink
docs: Updated docs to retrieve auth token (#280)
Browse files Browse the repository at this point in the history
* Updated docs to retrieve auth token

Signed-off-by: Omkar Phansopkar <[email protected]>

* Fixed punctuation

Signed-off-by: Omkar Phansopkar <[email protected]>

---------

Signed-off-by: Omkar Phansopkar <[email protected]>
  • Loading branch information
OmkarPh authored Apr 11, 2024
1 parent 75dc362 commit a2b087c
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions docs/contributing/set-up-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,11 @@ The following steps outline how to obtain an authentication token from the [hot.

![Avatar in top right corner of the page](../../static/img/contributing-avatar-top-right.png)

2. Click on the **Print auth token** option. Don't worry, this is a safe operation. The token is only printed to the console.
2. Click on the "Copy auth token" option to copy your auth token to clipboard.

![Print Auth Token](../../static/img/contributing-print-auth-token.png)
![Copy Auth Token](../../static/img/contributing-copy-auth-token.png)

3. Copy the token that is printed to the console.

![Token printed to the console](../../static/img/contributing-token-printed-to-console.png)

4. You can now use this token to make authenticated requests to the OpenSauced public API by including it in the Authorization header of your requests. For example:
3. You can now use this token to make authenticated requests to the OpenSauced public API by including it in the Authorization header of your requests. For example:

```javascript
const response = await fetch(
Expand Down
Binary file modified static/img/contributing-avatar-top-right.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/contributing-copy-auth-token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/img/contributing-print-auth-token.png
Binary file not shown.

0 comments on commit a2b087c

Please sign in to comment.