Skip to content

Commit d352c78

Browse files
committed
replace template default values
1 parent e444805 commit d352c78

File tree

8 files changed

+52
-198
lines changed

8 files changed

+52
-198
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to quarto-template
1+
# Contributing to description-file
22

3-
First off, thanks for taking the time to contribute to `quarto-template`!
3+
First off, thanks for taking the time to contribute to `description-file`!
44

55
All types of contributions are encouraged and valued. See the
66
[Table of contents](#table-of-contents) for different ways to help and details
@@ -24,13 +24,13 @@ maintainers and smooth out the experience for all involved.
2424

2525
## Code of conduct
2626

27-
This project is released with a [Contributor Code of Conduct](https://github.com/rdatatoolbox/quarto-template/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to <rdev.nc@gmail.com>.
27+
This project is released with a [Contributor Code of Conduct](https://github.com/rdatatoolbox/description-file/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to <rdev.nc@gmail.com>.
2828

2929

3030

3131
## Style guide
3232

33-
We use the [Tidyverse style guide](https://style.tidyverse.org/) for writing R code. Functions are documented with the [roxygen2](https://roxygen2.r-lib.org/articles/roxygen2.html) syntax. `quarto-template` uses the `lower_snake_case`.
33+
We use the [Tidyverse style guide](https://style.tidyverse.org/) for writing R code. Functions are documented with the [roxygen2](https://roxygen2.r-lib.org/articles/roxygen2.html) syntax. `description-file` uses the `lower_snake_case`.
3434

3535

3636

@@ -42,12 +42,12 @@ If you want to contribute by commiting changes, please try to use the [Conventio
4242

4343
## Asking questions
4444

45-
Before you ask a question, it is best to search for existing [Issues](https://github.com/rdatatoolbox/quarto-template/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
45+
Before you ask a question, it is best to search for existing [Issues](https://github.com/rdatatoolbox/description-file/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
4646

4747
If you then still feel the need to ask a question and need clarification, we recommend the following:
4848

49-
- Open a new [Issue](https://github.com/rdatatoolbox/quarto-template/issues/new).
50-
- Use the template [other_issue.md](https://github.com/rdatatoolbox/quarto-template/blob/main/.github/ISSUE_TEMPLATE/other_issue.md).
49+
- Open a new [Issue](https://github.com/rdatatoolbox/description-file/issues/new).
50+
- Use the template [other_issue.md](https://github.com/rdatatoolbox/description-file/blob/main/.github/ISSUE_TEMPLATE/other_issue.md).
5151
- Provide as much context as you can about what you're running into.
5252
- Provide project and platform versions (paste the output of `sessionInfo()`).
5353

@@ -63,19 +63,19 @@ We will then take care of the issue as soon as possible.
6363

6464
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
6565

66-
- Make sure that you are using the latest version of `quarto-template`.
66+
- Make sure that you are using the latest version of `description-file`.
6767
- Determine if your bug is really a bug and not an error on your side.
68-
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/rdatatoolbox/quarto-template/issues?q=label%3Abug).
68+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/rdatatoolbox/description-file/issues?q=label%3Abug).
6969

7070

7171

7272
### How do I submit a bug report?
7373

74-
We use [GitHub Issues](https://github.com/rdatatoolbox/quarto-template/issues) to
74+
We use [GitHub Issues](https://github.com/rdatatoolbox/description-file/issues) to
7575
track bugs and errors. If you run into an issue with the project:
7676

77-
- Open a new [Issue](https://github.com/rdatatoolbox/quarto-template/issues/new).
78-
- Use the template [bug_report.md](https://github.com/rdatatoolbox/quarto-template/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
77+
- Open a new [Issue](https://github.com/rdatatoolbox/description-file/issues/new).
78+
- Use the template [bug_report.md](https://github.com/rdatatoolbox/description-file/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
7979
- Explain the behavior you would expect and the actual behavior.
8080
- Please provide as much context as possible and describe the
8181
*reproduction steps* that someone else can follow to recreate the issue on
@@ -91,21 +91,21 @@ We will then take care of the issue as soon as possible.
9191

9292
### Before requesting a feature
9393

94-
- Make sure that you are using the latest version of `quarto-template`.
95-
- Read the [documentation](https://github.com/rdatatoolbox/quarto-template/) and the [wiki](https://github.com/rdatatoolbox/quarto-template/wiki) carefully and find out if the functionality is already covered.
96-
- Perform a [search](https://github.com/rdatatoolbox/quarto-template/issues) to see if this enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
94+
- Make sure that you are using the latest version of `description-file`.
95+
- Read the [documentation](https://github.com/rdatatoolbox/description-file/) and the [wiki](https://github.com/rdatatoolbox/description-file/wiki) carefully and find out if the functionality is already covered.
96+
- Perform a [search](https://github.com/rdatatoolbox/description-file/issues) to see if this enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
9797

9898

9999

100100
### How do I submit a feature request?
101101

102-
Feature requests are tracked as [GitHub Issues](https://github.com/rdatatoolbox/quarto-template/issues).
102+
Feature requests are tracked as [GitHub Issues](https://github.com/rdatatoolbox/description-file/issues).
103103

104-
- Open a new [Issue](https://github.com/rdatatoolbox/quarto-template/issues/new).
105-
- Use the template [feature_request.md](https://github.com/rdatatoolbox/quarto-template/blob/main/.github/ISSUE_TEMPLATE/feature_request.md).
104+
- Open a new [Issue](https://github.com/rdatatoolbox/description-file/issues/new).
105+
- Use the template [feature_request.md](https://github.com/rdatatoolbox/description-file/blob/main/.github/ISSUE_TEMPLATE/feature_request.md).
106106
- Provide a clear and descriptive title for the issue to identify the suggestion.
107107
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
108-
- Explain why this enhancement would be useful to most `quarto-template` users.
108+
- Explain why this enhancement would be useful to most `description-file` users.
109109

110110
We will then take care of the issue as soon as possible.
111111

@@ -122,7 +122,7 @@ We use the [GitHub flow](https://docs.github.com/en/get-started/quickstart/githu
122122
1. Make your contribution.
123123
1. Stage (`git add`) and commit (`git commit`) your changes as often as necessary
124124
1. Push your changes to GitHub w/ `git push origin branch-name`.
125-
3. Submit a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) on the [original repo](https://github.com/rdatatoolbox/quarto-template/compare).
125+
3. Submit a [Pull Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-a-pull-request) on the [original repo](https://github.com/rdatatoolbox/description-file/compare).
126126

127127
We will then review the PR as soon as possible.
128128

README.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,12 @@
1-
<!-- Delete the chunk from here... -->
2-
3-
> [!IMPORTANT]
4-
> Please visit our [**Wiki**](https://github.com/rdatatoolbox/quarto-template/wiki) to learn more about this Template.
5-
6-
<!-- ... to here -->
7-
8-
9-
101
<!-- Logo & Title -->
112

123
<h1 align="center">
134
<br>
145
<img src="images/readme/logo-readme.png" alt="Logo" width="200">
156
<br>
16-
Quarto template
7+
The **`DESCRIPTION`** file
178
<br>
18-
HTML presentation w/ RevealJS
9+
Store project metadata & dependencies in one place
1910
<br>
2011
</h1>
2112

@@ -24,7 +15,7 @@
2415

2516
<br>
2617
<p align="center">
27-
<a href="https://rdatatoolbox.github.io/quarto-template" target="_blank"><b>View presentation</b></a>
18+
<a href="https://rdatatoolbox.github.io/description-file" target="_blank"><b>View presentation</b></a>
2819
</p>
2920
<br>
3021

@@ -46,13 +37,13 @@
4637
<br/>
4738

4839
<!-- Quarto render -->
49-
<a href="https://github.com/rdatatoolbox/quarto-template/actions/workflows/quarto-render.yml">
50-
<img src="https://github.com/rdatatoolbox/quarto-template/actions/workflows/quarto-render.yml/badge.svg" alt="GHA render">
40+
<a href="https://github.com/rdatatoolbox/description-file/actions/workflows/quarto-render.yml">
41+
<img src="https://github.com/rdatatoolbox/description-file/actions/workflows/quarto-render.yml/badge.svg" alt="GHA render">
5142
</a>
5243

5344
<!-- GitHub deployment -->
54-
<a href="https://github.com/rdatatoolbox/quarto-template/actions/workflows/pages/pages-build-deployment">
55-
<img src="https://github.com/rdatatoolbox/quarto-template/actions/workflows/pages/pages-build-deployment/badge.svg" alt="GHA deploy">
45+
<a href="https://github.com/rdatatoolbox/description-file/actions/workflows/pages/pages-build-deployment">
46+
<img src="https://github.com/rdatatoolbox/description-file/actions/workflows/pages/pages-build-deployment/badge.svg" alt="GHA deploy">
5647
</a>
5748
</p>
5849

@@ -72,7 +63,7 @@
7263

7364
## Overview
7465

75-
This repository contains files used to generate the online presentation [Quarto template](https://rdatatoolbox.github.io/quarto-template) based on [Quarto](https://quarto.org/) and the [RevealJS](https://quarto.org/docs/presentations/revealjs/) framework.
66+
This repository contains files used to generate the online presentation [The `DESCRIPTION` file](https://rdatatoolbox.github.io/description-file) based on [Quarto](https://quarto.org/) and the [RevealJS](https://quarto.org/docs/presentations/revealjs/) framework.
7667

7768

7869
## Usage
@@ -91,14 +82,14 @@ To understand the file organisation of this repository, please read this [Wiki](
9182

9283
## Citation
9384

94-
Casajus N (2024) _A Quarto template for HTML presentation with RevealJS framework_. Online presentation available at <https://github.com/rdatatoolbox/quarto-template/>.
85+
Casajus N (2025) _The `DESCRIPTION` file: Store project metadata & dependencies in one place_. Online presentation available at <https://github.com/rdatatoolbox/description-file/>.
9586

9687

9788
## Contributing
9889

99-
All types of contributions are encouraged and valued. For more information, check out our [Contributor Guidelines](https://github.com/rdatatoolbox/quarto-template/blob/main/CONTRIBUTING.md).
90+
All types of contributions are encouraged and valued. For more information, check out our [Contributor Guidelines](https://github.com/rdatatoolbox/description-file/blob/main/CONTRIBUTING.md).
10091

101-
Please note that the `quarto-template` project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
92+
Please note that the `description-file` project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
10293

10394

10495
## Acknowledgments

_quarto.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
project:
2-
title: "Presentation title"
2+
title: "DESCRIPTION file"
33

4-
pagetitle: "Presentation title"
4+
pagetitle: "DESCRIPTION file"

index.qmd

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ from: markdown+emoji
33
format:
44
revealjs:
55
logo: images/logo-affiliation.png
6-
footer: "{{< fa brands github >}} &nbsp;[`rdatatoolbox/quarto-template`](https://github.com/rdatatoolbox/quarto-template) &nbsp; &bull; &nbsp; {{< fa brands creative-commons >}} {{< fa brands creative-commons-by >}} &nbsp;[`cc-by-4.0`](https://creativecommons.org/licenses/by/4.0/deed.en)"
6+
footer: "{{< fa brands github >}} &nbsp;[`rdatatoolbox/description-file`](https://github.com/rdatatoolbox/description-file) &nbsp; &bull; &nbsp; {{< fa brands creative-commons >}} {{< fa brands creative-commons-by >}} &nbsp;[`cc-by-4.0`](https://creativecommons.org/licenses/by/4.0/deed.en)"
77
smaller: true
88
auto-stretch: false
99
chalkboard: true
@@ -19,16 +19,9 @@ engine: knitr
1919
```
2020

2121

22-
<!-- Insert section 'Table of contents' -->
23-
24-
```{r}
25-
#| child: "sections/table-of-contents.qmd"
26-
```
27-
28-
2922
<!-- Insert section 'Quarto basics' -->
3023

3124
```{r}
32-
#| child: "sections/quarto-basics.qmd"
25+
#| child: "sections/main-slides.qmd"
3326
```
3427

sections/main-slides.qmd

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## What is it?
2+
3+
...
4+
5+
6+
7+
## Project metadata
8+
9+
...
10+
11+
12+
13+
## Project dependencies
14+
15+
...

sections/quarto-basics.qmd

Lines changed: 0 additions & 111 deletions
This file was deleted.

sections/table-of-contents.qmd

Lines changed: 0 additions & 34 deletions
This file was deleted.

sections/title-slide.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
::: {.column .information width="68%"}
1212

1313
::: {.title}
14-
Quarto template
14+
The **`DESCRIPTION`** file
1515
:::
1616

1717
::: {.subtitle}
18-
HTML presentation w/ RevealJS framework
18+
Store project metadata & dependencies in one place
1919
:::
2020

2121
::: {.date}

0 commit comments

Comments
 (0)