Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions contributing.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ format:
toc-expand: 4
---

You can contribute to the {{< var title >}} by making small edits, writing entirely new topics, or writing guides. All contributions are welcome and appreciated, small and large. There are two ways to contribute: [via GitHub](#contributing-via-github) or by using the [contribution portal](#contributing-portal). If you are in need of specific information, you can skip ahead using the table of contents.
You can contribute to the {{< var title >}} by making small edits, writing entirely new topics, or writing guides. All contributions are welcome and appreciated, small and large. There are two ways to contribute: [via GitHub](#contributing-via-github) or by using the [contribution portal](#contributing-portal). If you are in need of specific information, you can skip ahead using the table of contents.

## Contributing portal

Expand Down Expand Up @@ -163,7 +163,7 @@ This Contributing guide is located in the "root" directory, and there is no uppe
Relative links link to the `.qmd` files, never to the `.html` pages. These only exist when the pages are rendered!
:::

If we were editing a topic, and we wanted to link out to a guide, we would need to use `../guides/example-guide.qmd`. This because we would be in the topic folder for that file, and need to navigate one level up (`../`) and then down into the guides folder.
If we were editing a topic, and we wanted to link out to a guide, we would need to use `../guides/example-guide.qmd`. This because we would be in the topic folder for that file, and need to navigate one level up (`../`) and then down into the guides folder. For topic to topic references, we do the same (`../topics/example-topic.qmd`). This ensures that the links work also when a topic is embedded into a guide directly.

##### Section links

Expand Down
4 changes: 4 additions & 0 deletions editors-guide.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ The current editors are:

They can be pinged on GitHub as a team by using `@ubvu/editors` as the tag.

:::{.callout-tip}
For [the handbook's technical details, we have a separate page!](./technical-details.qmd)
:::

## What does an editor do?

Editors tie together all the strings in this VU Amsterdam community handbook. We keep a bird's eye view to ensure that what you read makes sense. Editors also help ensure the style and quality of the different pages are similar. Editors also help keep the content relevant to the entirety of VU Amsterdam (faculty specific information is not within scope).
Expand Down
6 changes: 6 additions & 0 deletions technical-details.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ We use GitHub Actions to build the Quarto website. This automation runs every ti

We use GitHub to subsequently make the website available on `https://rdm.vu.nl`.

Please [refer to the Quarto documentation for detailed instructions](https://quarto.org/docs/websites/) on how to use Quarto.

## Preview deployments

We use Netlify to automatically build previews of pull requests on GitHub. This is provided by Liberate Science GmbH, and is not critical to the operation of `https://rdm.vu.nl`. It does, however, help the editors manage changes to the handbook.
Expand All @@ -33,6 +35,10 @@ Understanding the repository structure helps you locate and modify the right fil
- **`contributing.qmd`** - Contributing guidelines
- **`editors-guide.qmd`** - Editor documentation

#### `_quarto.yml`

The `_quarto.yml` file is especially important, as it contains the metadata and information to structure the handbook. You can use this to find and update the navigation bar. The specifics of [using `_quarto.yml` is documented very well by Quarto](https://quarto.org/docs/websites/website-tools.html).

### Content organization

- **`topics/`** - Individual topic pages (e.g., `data-management-plan.qmd`, `gdpr.qmd`)
Expand Down