Skip to content

Commit c8b1e8f

Browse files
refactor: ♻️ move metadata to metadata file (#178)
# Description This PR moves website metadata into a separate metadata file. This PR needs a quick review. ## Checklist - [x] Formatted Markdown - [x] Ran `just run-all` Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com>
1 parent 1d267c9 commit c8b1e8f

File tree

6 files changed

+36
-30
lines changed

6 files changed

+36
-30
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11

22

3-
# An opinionated template for Data Packages built with Seedcase packages
3+
# Template Data Package: An opinionated setup for making FAIR and structured data using Seedcase Python packages
44

55
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.16540439.svg)](https://doi.org/10.5281/zenodo.16540439)
6-
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true)](https://github.com/copier-org/copier)
6+
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true.svg)](https://github.com/copier-org/copier)
77
[![GitHub
8-
License](https://img.shields.io/github/license/seedcase-project/template-data-package)](https://github.com/seedcase-project/template-data-package/blob/main/LICENSE.md)
8+
License](https://img.shields.io/github/license/seedcase-project/template-data-package.svg)](https://github.com/seedcase-project/template-data-package/blob/main/LICENSE.md)
99
[![GitHub
10-
Release](https://img.shields.io/github/v/release/seedcase-project/template-data-package)](https://github.com/seedcase-project/template-data-package/releases/latest)
11-
[![Test](https://github.com/seedcase-project/template-data-package/actions/workflows/test.yml/badge.svg)](https://github.com/seedcase-project/template-data-package/actions/workflows/build-package.yml)
10+
Release](https://img.shields.io/github/v/release/seedcase-project/template-data-package.svg)](https://github.com/seedcase-project/template-data-package/releases/latest)
11+
[![Test](https://github.com/seedcase-project/template-data-package/actions/workflows/test.yml/badge.svg)](https://github.com/seedcase-project/template-data-package/actions/workflows/test.yml)
1212
[![Build
13-
documentation](https://github.com/seedcase-project/template-data-package/actions/workflows/build-website.yml/badge.svg)](https://github.com/seedcase-project/template-data-package/actions/workflows/build-website.yml)
13+
website](https://github.com/seedcase-project/template-data-package/actions/workflows/build-website.yml/badge.svg)](https://github.com/seedcase-project/template-data-package/actions/workflows/build-website.yml)
1414
[![CodeQL](https://github.com/seedcase-project/template-data-package/actions/workflows/github-code-scanning/codeql/badge.svg?branch=main)](https://github.com/seedcase-project/template-data-package/actions/workflows/github-code-scanning/codeql)
1515
[![pre-commit.ci
1616
status](https://results.pre-commit.ci/badge/github/seedcase-project/template-data-package/main.svg)](https://results.pre-commit.ci/latest/github/seedcase-project/template-data-package/main)
@@ -56,8 +56,7 @@ requests :tada:
5656

5757
## Licensing
5858

59-
This project is licensed under the [MIT
60-
License](https://github.com/seedcase-project/template-data-package/blob/main/LICENSE.md).
59+
This project is licensed under the [MIT License](LICENSE.md).
6160

6261
## Citing
6362

README.qmd

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ format: gfm
33
execute:
44
echo: false
55
jupyter: python3
6-
repo: "template-data-package"
6+
metadata-files:
7+
- _metadata.yml
78
---
89

9-
# An opinionated template for Data Packages built with Seedcase packages
10+
# {{< meta titles.full >}}
1011

1112
{{< include /docs/includes/_badges.qmd >}}
1213

@@ -17,16 +18,18 @@ the necessary files and configurations in place, including for
1718
developing the Data Package. See the features section below for details
1819
on what is included in this template.
1920

20-
Check out our [website](https://{{< meta repo >}}.seedcase-project.org/)
21-
for more information, such as a
22-
[guide](https://{{< meta repo >}}.seedcase-project.org/docs/guide/) for
23-
using the template. For a list of changes, see our
24-
[changelog](https://{{< meta repo >}}.seedcase-project.org/CHANGELOG/)
21+
Check out our
22+
[website](https://{{< meta gh.repo >}}.{{< meta gh.org >}}.org/) for
23+
more information, such as a
24+
[guide](https://{{< meta gh.repo >}}.{{< meta gh.org >}}.org/docs/guide/)
25+
for using the template. For a list of changes, see our
26+
[changelog](https://{{< meta gh.repo >}}.{{< meta gh.org >}}.org/CHANGELOG)
2527
page.
2628

2729
## Contributing
2830

29-
Check out our [contributing page](https://{{< meta repo >}}.seedcase-project.org/CONTRIBUTING/)
31+
Check out our [contributing
32+
page](https://{{< meta gh.repo >}}.{{< meta gh.org >}}.org/CONTRIBUTING/)
3033
for information on how to contribute to the project, including how to
3134
set up your development environment.
3235

@@ -40,8 +43,7 @@ to abide by its terms.
4043

4144
## Licensing
4245

43-
This project is licensed under the [MIT
44-
License](https://github.com/seedcase-project/{{< meta repo >}}/blob/main/LICENSE.md).
46+
This project is licensed under the [MIT License](LICENSE.md).
4547

4648
## Citing
4749

_metadata.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Metadata for the website
2+
gh:
3+
org: "seedcase-project"
4+
repo: "template-data-package"
5+
6+
titles:
7+
full: "Template Data Package: An opinionated setup for making FAIR and structured data using Seedcase Python packages"
8+
short: "Template Data Package"

_quarto.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,3 @@ editor:
5050

5151
execute:
5252
echo: false
53-
54-
# Metadata for the website
55-
repo: "template-data-package"

docs/includes/_badges.qmd

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.16540439.svg)](https://doi.org/10.5281/zenodo.16540439)
2-
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true)](https://github.com/copier-org/copier)
3-
[![GitHub License](https://img.shields.io/github/license/seedcase-project/{{< meta repo >}})](https://github.com/seedcase-project/{{< meta repo >}}/blob/main/LICENSE.md)
4-
[![GitHub Release](https://img.shields.io/github/v/release/seedcase-project/{{< meta repo >}})](https://github.com/seedcase-project/{{< meta repo >}}/releases/latest)
5-
[![Test](https://github.com/seedcase-project/{{< meta repo >}}/actions/workflows/test.yml/badge.svg)](https://github.com/seedcase-project/{{< meta repo >}}/actions/workflows/build-package.yml)
6-
[![Build documentation](https://github.com/seedcase-project/{{< meta repo >}}/actions/workflows/build-website.yml/badge.svg)](https://github.com/seedcase-project/{{< meta repo >}}/actions/workflows/build-website.yml)
7-
[![CodeQL](https://github.com/seedcase-project/{{< meta repo >}}/actions/workflows/github-code-scanning/codeql/badge.svg?branch=main)](https://github.com/seedcase-project/{{< meta repo >}}/actions/workflows/github-code-scanning/codeql)
8-
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/seedcase-project/{{< meta repo >}}/main.svg)](https://results.pre-commit.ci/latest/github/seedcase-project/{{< meta repo >}}/main)
2+
[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-teal.json?raw=true.svg)](https://github.com/copier-org/copier)
3+
[![GitHub License](https://img.shields.io/github/license/{{< meta gh.org >}}/{{< meta gh.repo >}}.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/blob/main/LICENSE.md)
4+
[![GitHub Release](https://img.shields.io/github/v/release/{{< meta gh.org >}}/{{< meta gh.repo >}}.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/releases/latest)
5+
[![Test](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/test.yml/badge.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/test.yml)
6+
[![Build website](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/build-website.yml/badge.svg)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/build-website.yml)
7+
[![CodeQL](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/github-code-scanning/codeql/badge.svg?branch=main)](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}}/actions/workflows/github-code-scanning/codeql)
8+
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/{{< meta gh.org >}}/{{< meta gh.repo >}}/main.svg)](https://results.pre-commit.ci/latest/github/{{< meta gh.org >}}/{{< meta gh.repo >}}/main)
99
[![lifecycle](https://lifecycle.r-lib.org/articles/figures/lifecycle-experimental.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
1010
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

index.qmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ configurations in place, including for developing the Data Package.
4646
## Want to contribute?
4747

4848
We would love your feedback or contributions! Head over to our [GitHub
49-
repository](https://github.com/seedcase-project/{{< meta repo >}}) to
50-
share your ideas or contribute code. Your input makes us better!
49+
repository](https://github.com/{{< meta gh.org >}}/{{< meta gh.repo >}})
50+
to share your ideas or contribute code. Your input makes us better!
5151

5252
### Contributors
5353

0 commit comments

Comments
 (0)