Skip to content

Commit

Permalink
add step to add the subtitle to listing index
Browse files Browse the repository at this point in the history
  • Loading branch information
avallecam committed Oct 4, 2024
1 parent ae1ba94 commit ebcf350
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ After following the steps above:

#### 1. Find your folder

Folder names corresponds to each box of the [pipeline roadmap](https://epiverse-trace.github.io/) within the `analyses/` folder:
Folder names corresponds to each task (box) of the [pipeline roadmap](https://epiverse-trace.github.io/getting-started.html#roadmap) within the `analyses/` folder:

- `read_cases/` → Read case data
- `describe_cases/` → Describe case data
Expand Down Expand Up @@ -92,7 +92,7 @@ Use the [**Render** button](https://quarto.org/docs/get-started/hello/rstudio.ht

To render the whole website, use the **Render Website** button within the [Build pane](https://docs.posit.co/ide/user/ide/guide/ui/ui-panes.html).

If your entry is not listed in the `index.qmd` page, try adding a new entry to the `listing:` section in the YAML on top. In the template below, edit the `id:` and `contents:` with for the corresponding task.
If the task (folder) of your entry is not listed in the `index.qmd` page, First, add a new task entry to the `listing:` section in the YAML on top. In the template below, edit the `id:` and `contents:` with for the corresponding task (folder name). For example, for the task `"Describe case data"` with used as ID `describe-cases` and detailed the folder path `analyses/describe_cases/*.qmd`:

```
listing:
Expand All @@ -102,6 +102,15 @@ listing:
fields: [title]
```

Second, to make the listing visible in the website, add a subtitle with the task name (`Describe case data`) and refer to the ID (`describe-cases`) in the following format:

```
## Describe case data
:::{#describe-cases}
:::
```

#### 6. Add new packages to renv

We use the [{renv} R package](https://rstudio.github.io/renv/) to ensure reproducibility of the how-to guides we are providing. All packages used in this repository are registered in the [`renv.lock`](https://github.com/epiverse-trace/howto/blob/main/renv.lock) file.
Expand Down

0 comments on commit ebcf350

Please sign in to comment.