Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.

Commit 3d20e96

Browse files
docs: fixes headings so that the sidebar is cleaner in dashboards as code doc (#32)
* fixes headings so that the sidebar is cleaner in dashboards as code doc * matches sidebar headers
1 parent 5f30307 commit 3d20e96

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

docs/references/dashboards-as-code.mdx

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import DownloadContent from './assets/download-content.jpg';
44

55
You can download your charts and dashboards as code, make changes, then upload your changes back to your Lightdash project using the CLI. Content as code is also useful for creating new Lightdash projects where you want the content to be copied from an existing project and added to your new project.
66

7-
## `lightdash download` downloads content as code
7+
## `lightdash download`
88

99
From the [Lightdash CLI](/references/lightdash-cli), you can use the command `lightdash download` to download all of the charts and dashboards from your Lightdash project as code. All of the charts and dashboards will be written as .yml files to a `lightdash` directory wherever you're running the command.
1010

@@ -26,7 +26,7 @@ For example:
2626
- I run `lightdash download` again
2727
- The changes I made to `emea-revenue-per-month.yml` will be overwritten by the latest chart version downloaded from the Lightdash application
2828

29-
### Use `lightdash download -c` or `lightdash download --charts` to select specific charts
29+
### Select specific items to download
3030

3131
If you only want to download specific charts to manage as code, you can use the chart selector in the download command.
3232

@@ -38,7 +38,7 @@ lightdash download -c https://app.lightdash.cloud/the-url-to-my-saved-chart
3838

3939
You can use the chart's SLUG, UUID, or the URL to the saved chart to select the chart.
4040

41-
### Use `lightdash download -d` or `lightdash download --dashboards` to select specific dashboards
41+
**Use `lightdash download -d` or `lightdash download --dashboards` to select specific dashboards**
4242

4343
This will download the dashboard and all of the charts in the dashboard as code. For example, if I only wanted to download a specific dashboard as code, I would run the command:
4444

@@ -62,7 +62,7 @@ You can combine charts and dashboards selection in a single command. For example
6262
lightdash download -c https://app.lightdash.cloud/the-url-to-my-first-saved-chart -d https://app.lightdash.cloud/the-url-to-my-dashboard
6363
```
6464

65-
### Use `lightdash download -p` or `lightdash download --path` to specify a directory to download to
65+
### Specify your download path
6666

6767
By default, `lightdash download` will create a new `lightdash` directory in your current working directory and write the content there. You can customize the directory that you write to using `lightdash download -p`. For example:
6868

@@ -78,7 +78,7 @@ You can also use relative paths like:
7878
lightdash download -p ../
7979
```
8080

81-
### Use `lightdash download --project <project UUID>` to download all content from a specific project
81+
### Specify a project to download
8282

8383
Running `lightdash download` will download all content from your current set project (set using `lightdash config set-project`). But, you can download content from another project using `lightdash download --project my-project-uuid`. For example:
8484

@@ -88,11 +88,11 @@ lightdash download --project 21eef0b9-5bae-40f3-851e-9554588e71a6
8888

8989
You can find a project's UUID from your Lightdash URL. For example, `https://app.lightdash.cloud/projects/123-project-uuid/`. Here, the project UUID here is `123-project-uuid` .
9090

91-
## `lightdash upload` updates any content as code to your project
91+
## `lightdash upload`
9292

9393
From the [Lightdash CLI](/references/lightdash-cli), you can use the command `lightdash upload` to upload any changes you've made to your charts or dashboards as code. To upload new charts that you've created as code to your Lightdash project, you need to run `lightdash upload --force`
9494

95-
### Use `lightdash upload -c` or `lightdash upload --charts` to select specific charts
95+
### Select specific items to upload
9696

9797
For example, if I only wanted to upload a specific saved chart as code, I would run the command:
9898

@@ -102,9 +102,7 @@ lightdash upload -c my-saved-chart-slug
102102

103103
You must specify the chart using the chart's SLUG.
104104

105-
### Use `lightdash upload -d` or `lightdash upload --dashboards` to select specific dashboards
106-
107-
For example, if I only wanted to upload a specific dashboard as code, I would run the command:
105+
If I only wanted to upload a specific dashboard as code, I would run the command:
108106

109107
```bash
110108
lightdash upload -d my-dashboard-slug
@@ -120,7 +118,7 @@ For example, this command would select two charts to upload:
120118
lightdash upload -c my-saved-chart-1-slug my-saved-chart-2-slug
121119
```
122120

123-
### Use `lightdash upload -p` or `lightdash upload --path` to specify a directory to upload from
121+
### Specify your upload path
124122

125123
By default, `lightdash upload` will upload all items you have saved in the `lightdash` directory in your current working directory. You can customize the directory that you upload from using `lightdash upload -p`. For example:
126124

@@ -136,7 +134,7 @@ You can also use relative paths like:
136134
lightdash download -p ../
137135
```
138136

139-
### Use `lightdash upload --project <project UUID>` to upload your content to a specific project
137+
### Specify a project to upload to
140138

141139
Running `lightdash upload` will upload all content to your current set project (set using `lightdash config set-project`). But, you can upload content to another project using `lightdash upload --project my-project-uuid`. For example:
142140

0 commit comments

Comments
 (0)