Stadt-Geschichte-Basel · maehr · Dec 6, 2024 · Dec 6, 2024 · Dec 6, 2024 · Dec 6, 2024
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,8 +1,8 @@
 contact_links:
-  - name: Are you looking for documentation on REPO_NAME?
-    url: https://USERNAME.github.io/REPO_NAME
-    about: Please see the documentation for REPO_NAME on its GitHub Pages page.
-  - name: Do want to discuss REPO_NAME with the community?
-    url: https://github.com/USERNAME/REPO_NAME/discussions
-    about: Please see the discussions page for REPO_NAME.
+  - name: Are you looking for documentation on stadt-geschichte-basel.github.io?
+    url: https://Stadt-Geschichte-Basel.github.io/stadt-geschichte-basel.github.io
+    about: Please see the documentation for stadt-geschichte-basel.github.io on its GitHub Pages page.
+  - name: Do want to discuss stadt-geschichte-basel.github.io with the community?
+    url: https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/discussions
+    about: Please see the discussions page for stadt-geschichte-basel.github.io.
 blank_issues_enabled: true
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 # Quarto
-.quarto/
+/.quarto/
 _site/
 
 # Exclude example.env

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/USERNAME/REPO_NAME/compare/...HEAD)
+## [Unreleased](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/compare/...HEAD)
 
 ### Documentation
 
@@ -16,13 +16,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial version
 
-## [0.0.2](https://github.com/USERNAME/REPO_NAME/compare/v0.0.1...v0.0.2) - 2020-02-26
+## [0.0.2](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/compare/v0.0.1...v0.0.2) - 2020-02-26
 
 ### Documentation
 
 - ...
 
-## [0.0.1](https://github.com/USERNAME/REPO_NAME/releases/tag/v0.0.1) - 2020-01-13
+## [0.0.1](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/releases/tag/v0.0.1) - 2020-01-13
 
 ### Features
 

diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,33 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: Stadt.Geschichte.Basel RDM & Public History documentation
+message: >-
+  If you use this dataset, please cite it using the metadata
+  from this file.
+type: dataset
+authors:
+  - given-names: Moritz
+    family-names: Mähr
+    email: [email protected]
+    affiliation: University of Basel
+    orcid: 'https://orcid.org/0000-0002-1367-1618'
+  - given-names: Moritz
+    family-names: Twente
+    email: [email protected]
+    affiliation: University of Basel
+    orcid: 'https://orcid.org/0009-0005-7187-9774'
+repository-code: >-
+  https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io
+url: 'https://stadt-geschichte-basel.github.io'
+abstract: >-
+  This repository contains the documentation of the work of
+  the team for research data management and digital
+  education of Stadt.Geschichte.Basel.
+keywords:
+  - research data management
+  - documentation
+  - public history
+  - digital history
+license: AGPL-3.0
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
+[email protected].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

diff --git a/README.md b/README.md
@@ -1,95 +1,28 @@
-# GitHub template for FAIR and open research data
+# stadt-geschichte-basel.github.io
 
-This GitHub template is independent of the (research) data and its format. It follows the best practices for open research data as outlined in [The Turing Way](https://the-turing-way.netlify.app/). It uses [GitHub Actions](https://docs.github.com/en/actions) to manage releases, issues, and pull requests, [GitHub Pages](https://pages.github.com/) for documentation, and [Zenodo](https://zenodo.org/) for long-term archiving.
+This repository contains the documentation of the work of the team for research data management and digital education of Stadt.Geschichte.Basel.
 
-[![GitHub issues](https://img.shields.io/github/issues/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/issues)
-[![GitHub forks](https://img.shields.io/github/forks/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/network)
-[![GitHub stars](https://img.shields.io/github/stars/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/stargazers)
-[![Code license](https://img.shields.io/github/license/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/blob/main/LICENSE-AGPL.md)
-[![Data license](https://img.shields.io/github/license/maehr/open-research-data-template.svg)](https://github.com/maehr/open-research-data-template/blob/main/LICENSE-CCBY.md)
+[![GitHub issues](https://img.shields.io/github/issues/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io.svg)](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/issues)
+[![GitHub forks](https://img.shields.io/github/forks/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io.svg)](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/network)
+[![GitHub stars](https://img.shields.io/github/stars/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io.svg)](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/stargazers)
+[![Code license](https://img.shields.io/github/license/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io.svg)](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/blob/main/LICENSE-AGPL.md)
+[![Data license](https://img.shields.io/github/license/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io.svg)](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/blob/main/LICENSE-CCBY.md)
+[![DOI](https://zenodo.org/badge/ZENODO_RECORD.svg)](https://zenodo.org/badge/latestdoi/ZENODO_RECORD)
 
-<!-- FIXME [![DOI](https://zenodo.org/badge/ZENODO_RECORD.svg)](https://zenodo.org/badge/latestdoi/ZENODO_RECORD) -->
+## Repository Structure
 
-## Why use a template (even for small datasets)?
+The structure of this repository follows the [Advanced Structure for Data Analysis](https://the-turing-way.netlify.app/project-design/project-repo/project-repo-advanced.html) of _The Turing Way_ and is organized as follows:
 
-- Share your [open research data](#open-research-data) with others
-- Write better [documentation](#documentation) for yourself and the community
-- Write more [consistent](#consistency) code and encourage collaboration
-- Increase [security](#security)
-- Follow accepted [ethics](#ethics)
-
-## How this template helps you
-
-### Open research data
-
-- Citeable via [DOI](https://www.doi.org/) (and [CITATION.cff](https://citation-file-format.github.io/))
-- Automatic long-term archiving via [Zenodo](https://zenodo.org/)
-- Licensed under a non-restrictive [AGPL 3.0](LICENSE-AGPL.md) and [CC BY 4.0](LICENSE-CCBY.md) license according to [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/rdm/rdm-sharing.html#step-3-choose-a-licence-and-link-to-your-paper-and-code)
-- Templates for reporting data issues using a [custom template](.github/ISSUE_TEMPLATE/data_issue_report.md)
-
-### Documentation
-
-- [README.md](README.md) according to [www.makeareadme.com](https://www.makeareadme.com/) and [The Turing Way](https://the-turing-way.netlify.app/project-design/project-repo/project-repo-readme.html)
-- [CHANGELOG.md](CHANGELOG.md) according to [keepachangelog.com](https://keepachangelog.com/)
-- Automated [CHANGELOG.md](CHANGELOG.md) via [git-cliff](https://github.com/orhun/git-cliff)
-- [package.json](package.json) via [npm docs](https://docs.npmjs.com/cli/v7/configuring-npm/package-json)
-- Accessible documentation via [gh-pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages) and [Quarto](https://quarto.org/)
-
-### Consistency
-
-- Consistent formatting via [Prettier](https://prettier.io/)
-- Consistent commit messages according to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) via [husky](https://github.com/typicode/husky)
-- Consistent versioning via [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
-- Consistent [fork and pull](https://gist.github.com/Chaser324/ce0505fbed06b947d962) workflow via [GitHub branch protection](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)
-- Consistent issues via [issue templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)
-- Consistent file and folder naming conventions via [The Turing Way](https://the-turing-way.netlify.app/reproducible-research/rdm/rdm-storage.html#file-naming-conventions)
-
-### Security
-
-- [SECURITY.md](SECURITY.md) per [GitHub](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository)
-- [GitHub Security Alerts](https://github.blog/2017-11-16-introducing-security-alerts-on-github/)
-- Integrity via [GitHub branch protection](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/managing-a-branch-protection-rule)
-
-### Ethics
-
-- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) per the [Contributor Covenant](https://www.contributor-covenant.org/)
-- Friendly initial interactions via [Greetings](https://github.com/actions/starter-workflows/blob/main/automation/greetings.yml)
+- `contents/`: CMS content
 
 ## Installation
 
-To initialize the template, [generate](https://github.com/maehr/open-research-data-template/generate) a new project, [clone](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) the repository to your local machine and follow this guide.
-
-1. Install [Node.js](https://nodejs.org/en/) and run the following commands in the root directory of the repository:
+Install [Node.js](https://nodejs.org/en/download/package-manager) and [Quarto](https://quarto.org/docs/get-started/). Run the following commands in the root directory of the repository:
 
 ```bash
 npm install
-npm run prepare
 ```
 
-2. Complete the following checklist of tasks to customize the template for your project:
-
-- [ ] enable [GitHub security alerts](https://github.blog/2017-11-16-introducing-security-alerts-on-github/)
-- [ ] [protect](https://help.github.com/en/articles/configuring-protected-branches) the main branch to enforce a [fork and pull](https://gist.github.com/Chaser324/ce0505fbed06b947d962) workflow
-- [ ] search and replace `FULLNAME`, `USERNAME`, `REPO_NAME`, `SHORT_DESCRIPTION` `[INSERT CONTACT METHOD]` in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), [package.json](package.json), [README.template.md](README.template.md), [SECURITY.md](SECURITY.md)
-- [ ] setup the [Zenodo integration](https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content)
-- [ ] add `ZENODO_RECORD` to [README.md](README.md)
-- [ ] add favicons to `./`, e.g. via [favicon.io](https://favicon.io/)
-- [ ] search for `TODO` in the project (mostly documentation) and fix it
-- [ ] delete [README.md](README.md)
-- [ ] rename [README.template.md](README.template.md) to [README.md](README.md)
-- [ ] run `npm run format` to format all files
-- [ ] run `npm run commit` to commit all changes
-- [ ] run `npm run changelog` and include the output in [CHANGELOG.md](CHANGELOG.md)
-- [ ] install [Quarto](https://quarto.org/docs/get-started/)
-- [ ] run `quarto publish gh-pages` to publish the documentation
-- [ ] customize the documentation with [Quarto](https://quarto.org/docs/websites/#workflow)
-- [ ] enable [gh-pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages) for the `gh-pages` branch
-
-3. optional tasks:
-
-- [ ] add a `CITATION.CFF` according to [citation-file-format.github.io](https://citation-file-format.github.io/)
-- [ ] add a `.zenodo.json` according to [zenodo.org](https://developers.zenodo.org/?python#add-metadata-to-your-github-repository-release)
-
 ## Use
 
 Check that all files are properly formatted.
@@ -124,30 +57,36 @@ quarto preview
 
 ## Support
 
-This project is maintained by [@maehr](https://github.com/maehr). Please understand that we can't provide individual support via email. We also believe that help is much more valuable when it's shared publicly, so more people can benefit from it.
+This project is maintained by [@Stadt-Geschichte-Basel](https://github.com/Stadt-Geschichte-Basel). Please understand that we can't provide individual support via email. We also believe that help is much more valuable when it's shared publicly, so more people can benefit from it.
 
-| Type                                   | Platforms                                                                              |
-| -------------------------------------- | -------------------------------------------------------------------------------------- |
-| 🚨 **Bug Reports**                     | [GitHub Issue Tracker](https://github.com/maehr/open-research-data-template/issues)    |
-| 📊 **Report bad data**                 | [GitHub Issue Tracker](https://github.com/maehr/open-research-data-template/issues)    |
-| 📚 **Docs Issue**                      | [GitHub Issue Tracker](https://github.com/maehr/open-research-data-template/issues)    |
-| 🎁 **Feature Requests**                | [GitHub Issue Tracker](https://github.com/maehr/open-research-data-template/issues)    |
-| 🛡 **Report a security vulnerability** | See [SECURITY.md](SECURITY.md)                                                         |
-| 💬 **General Questions**               | [GitHub Discussions](https://github.com/maehr/open-research-data-template/discussions) |
+| Type                                   | Platforms                                                                                                    |
+| -------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
+| 🚨 **Bug Reports**                     | [GitHub Issue Tracker](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/issues)    |
+| 📊 **Report bad data**                 | [GitHub Issue Tracker](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/issues)    |
+| 📚 **Docs Issue**                      | [GitHub Issue Tracker](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/issues)    |
+| 🎁 **Feature Requests**                | [GitHub Issue Tracker](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/issues)    |
+| 🛡 **Report a security vulnerability** | See [SECURITY.md](SECURITY.md)                                                                               |
+| 💬 **General Questions**               | [GitHub Discussions](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/discussions) |
 
 ## Roadmap
 
-There are currently no changes planned.
+See <https://github.com/orgs/Stadt-Geschichte-Basel/projects/5> for the current roadmap.
 
 ## Contributing
 
-Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
+All contributions to this repository are welcome! If you find errors or problems with the data, or if you want to add new data or features, please open an issue or pull request. Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. The available versions are listed in the [tags on this repository](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/tags).
 
-## Authors and credits
+## Authors and acknowledgment
 
-- **Moritz Mähr** - _Initial work_ - [maehr](https://github.com/maehr)
+- **Stadt.Geschichte.Basel** - [Stadt-Geschichte-Basel](https://github.com/Stadt-Geschichte-Basel)
+- **Moritz Mähr** - [maehr](https://github.com/maehr)
+- **Moritz Twente** - [mtwente](https://github.com/mtwente)
 
-See also the list of [contributors](https://github.com/maehr/open-research-data-template/graphs/contributors) who contributed to this project.
+See also the list of [contributors](https://github.com/Stadt-Geschichte-Basel/stadt-geschichte-basel.github.io/graphs/contributors) who contributed to this project.
 
 ## License