Skip to content

Commit

Permalink
Embed video tutorials into the documentation (#169)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikescops committed Aug 17, 2023
1 parent dea9710 commit fe9bce7
Show file tree
Hide file tree
Showing 9 changed files with 145 additions and 91 deletions.
1 change: 1 addition & 0 deletions documentation/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ bundle
.DS_Store
.next
out
components/*.js

# Yarn related files
.pnp.*
Expand Down
15 changes: 15 additions & 0 deletions documentation/components/player.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import React from 'react';

export const YoutubePlayer = (props: { videoId: string }) => {
return (
<iframe
width="100%"
height="470"
style={{ marginTop: '20px', marginBottom: '20px' }}
src={'https://www.youtube-nocookie.com/embed/' + props.videoId + '?loop=1&modestbranding=1&color=white'}
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowFullScreen
></iframe>
);
};
3 changes: 3 additions & 0 deletions documentation/pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
"install": {
"title": "Install"
},
"guides": {
"title": "Guides"
},
"---1": {
"type": "separator"
},
Expand Down
14 changes: 14 additions & 0 deletions documentation/pages/guides.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Our guides in video

We made a series of videos to help you understand how to use the CLI.

<iframe
width="100%"
height="470"
style={{ marginTop: '20px' }}
src="https://www.youtube-nocookie.com/embed/videoseries?list=PLaJHdXnJiAn4rWs-YlmKuoX__33BAq_xf"
title="Dashlane CLI Playlist"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
3 changes: 3 additions & 0 deletions documentation/pages/personal/secrets/exec.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
import { Steps } from 'nextra/components';
import { YoutubePlayer } from '../../../components/player';

# Load secrets into environment variables

The Dashlane CLI allows you to load secrets into environment variables. This is useful for example when you want to use secrets in your applications in development.

By using secret references in your environment variables, you can load secrets from your Dashlane account into your environment variables and avoid having to store them in plain text in your code.

<YoutubePlayer videoId="A4TM6mSRwbs" />

<Steps>
### Get your secret reference

Expand Down
3 changes: 3 additions & 0 deletions documentation/pages/personal/secrets/inject.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import { Steps, Callout } from 'nextra/components';
import { YoutubePlayer } from '../../../components/player';

# Load secrets into templated files

Using Dashlane CLI you can inject secrets into templated files.
This is useful for example to inject secrets into configuration files and avoid storing secrets in your repository.

<YoutubePlayer videoId="FfjBC8MBAQk" />

<Steps>
### Get your secret reference

Expand Down
4 changes: 4 additions & 0 deletions documentation/pages/personal/secrets/read.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
import { YoutubePlayer } from '../../../components/player';

# Read secrets references

A secret reference is an URI starting by `dl://` that points to a secret stored in your vault.

You can use a secret reference to securely load a secret from your vault into environment variables, scripts or configuration files.

<YoutubePlayer videoId="i1TAKqM5nOg" />

## Structure of secret references

The URI is composed of 4 parts:
Expand Down
10 changes: 10 additions & 0 deletions documentation/pages/personal/vault.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { Callout } from 'nextra/components';
import { YoutubePlayer } from '../../components/player';

# Accessing your Vault

Expand All @@ -8,6 +9,8 @@ import { Callout } from 'nextra/components';

## Get a password

<YoutubePlayer videoId="dMII21YI5s4" />

```sh
dcli p mywebsite
# will return any entry for which either the url or the title matches mywebsite
Expand All @@ -26,12 +29,19 @@ Note: You can select a different output for passwords among `clipboard, password

## Generate an OTP code

You can get an OTP code from your vault as well as the remaining time before it expires.
Just use the `otp` or `o` command and filter similarly to the password command:

```sh copy
dcli otp [filters]
```

## Get a secure note

<YoutubePlayer videoId="n8OxYRfrgfk" />

Getting a secure note is very simple, just use the `note` or `n` command and filter by title:

```sh copy
dcli note [titleFilter]
```
Expand Down
183 changes: 92 additions & 91 deletions tsconfig.json

Large diffs are not rendered by default.

0 comments on commit fe9bce7

Please sign in to comment.