Skip to content

Commit

Permalink
Fix some xrefs
Browse files Browse the repository at this point in the history
  • Loading branch information
astrojuanlu committed Jul 24, 2022
1 parent 4e01960 commit 345efb2
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/development/concepts_in_orchest.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Projects
Projects. You can think of a Project as a folder on your filesystem that contains a bunch of
Files, some of which are "special" (hinting at Pipeline files with a `.orchest` extension). In
addition to the filesystem state, Orchest saves state in a database. This state includes things
such as {ref}`environment variables <environment variables>`.
such as {ref}`environment variables <environment-variables>`.

```{image} ../img/concepts/Project.png
:width: 200
Expand Down
2 changes: 1 addition & 1 deletion docs/source/fundamentals/jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ You can think of job parameters as a [grid search](https://scikit-learn.org/stab
i.e. looping over all combinations of values for different parameters.

```{note}
💡 Unlike {ref}`environment variables <environment variables>`, you can define
💡 Unlike {ref}`environment variables <environment-variables>`, you can define
pipeline and step level parameters with the same name without one (automatically) overwriting
the other, you can access both values.
```
Expand Down
2 changes: 1 addition & 1 deletion docs/source/fundamentals/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Pipelines take parameters as input (e.g. the data source connection URL) to vary
pipeline. Parameters can be set in the visual pipeline editor.

```{tip}
👉 For secrets, use {ref}`environment variables <environment variables>` since parameters are versioned.
👉 For secrets, use {ref}`environment variables <environment-variables>` since parameters are versioned.
```

## Data passing
Expand Down
5 changes: 3 additions & 2 deletions docs/source/fundamentals/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ A project's `.orchest` directory should be versioned since it defines the {ref}`

The `/data` directory can be used to store data locally that is accessible by all pipelines across all projects, even by jobs.

Secrets should be set with {ref}`environment variables <environment variables>` to avoid them being versioned.
Secrets should be set with {ref}`environment variables <environment-variables>` to avoid them being versioned.

(git-inside-orchest)=

Expand All @@ -55,7 +55,8 @@ Secrets should be set with {ref}`environment variables <environment variables>`
👉 See video tutorial: [versioning using git in Orchest](https://www.tella.tv/video/cknr9z9x0000709kz7vzh0wdx/view).
```

You can use `git` inside Orchest with the pre-installed [jupyterlab-git](https://github.com/jupyterlab/jupyterlab-git) extension. Get started by adding your `user.name` and `user.email` in {ref}`configure JupyterLab <configuration jupyterlab>`. For example:
You can use `git` inside Orchest with the pre-installed [jupyterlab-git](https://github.com/jupyterlab/jupyterlab-git) extension.
Get started by adding your `user.name` and `user.email` in {ref}`configure JupyterLab <configuration-jupyterlab>`. For example:

```sh
git config --global user.name "John Doe"
Expand Down

0 comments on commit 345efb2

Please sign in to comment.