feat: Setup repository for handbook v2.0.0alpha release with documentation improvements #33
Conversation
- Create v2.0.0alpha branch for development - Update package.json version to 2.0.0-alpha.0 - Add v2.0.0alpha development guidelines to CONTRIBUTING.md - Configure git-cliff for pre-release version support - Update CHANGELOG.md with alpha release planning
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Note Free review on us!CodeRabbit is offering free reviews until Wed Oct 08 2025 to showcase some of the refinements we've made. Comment |
There was a problem hiding this comment.
Pull Request Overview
This PR sets up the repository infrastructure for the v2.0.0alpha release of the diskriminierungsfreie-metadaten handbook. It establishes a new development branch, updates versioning to semantic versioning with alpha pre-release support, and provides comprehensive development guidelines for the v2 release cycle.
- Updates package.json version to 2.0.0-alpha.0 for semantic versioning
- Configures git-cliff to properly handle pre-release versions
- Adds detailed v2.0.0alpha development guidelines to CONTRIBUTING.md
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| package.json | Updates version to 2.0.0-alpha.0 for alpha release |
| cliff.toml | Removes skip_tags restriction and updates comments for pre-release support |
| CONTRIBUTING.md | Adds comprehensive v2.0.0alpha development guidelines and workflow |
| CHANGELOG.md | Documents the v2.0.0-alpha.0 release setup |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…ces and notes for improved adherence to language guidelines.
…; enhance keyword relevance and add anti-racist description resources.
…retical and practical guidance on discrimination-sensitive metadata practices.
…l longevity - Added article by Carroll et al. (2021) on operationalizing CARE and FAIR principles for Indigenous data. - Included the Endings principles for digital longevity from the University of Victoria (2023). - Added Europeana Data Model documentation for cultural heritage aggregation. - Introduced FORRT's webpage on paradata and its significance in data collection. - Added a resource on metadata standards from forschungsdaten.info (2024). - Included GIDA's CARE principles for Indigenous data governance (2025). - Added humanrights.ch's overview of discrimination forms in Switzerland. - Included Stadt.Geschichte.Basel's digital concept summary (2022). - Added Dublin Core Metadata Enhancer by Moritz Mähr (2025). - Included DARIAH Campus training on metadata and documentation (2024). - Added Stadt.Geschichte.Basel's data documentation practices (2025). - Included a white paper on data standards for historical research by the Swiss Society for History (2023). - Added online handbook for historical research by the University of Basel (2016). - Included the FAIR Data Principles publication by Wilkinson et al. (2016).
…ences; remove outdated images for improved clarity and relevance.
maehr
force-pushed
the
copilot/fix-375ae2cd-8824-493f-947e-daac7795f52c
branch
from
e708ff1 to
697c49c
Compare
|
@copilot Folgende Dinge sollten angepasst werden:
|
Co-authored-by: maehr <[email protected]>
I've addressed all the requested documentation improvements: ✅ Comprehensive glossary created ( The glossary includes detailed definitions for all major concepts, metadata standards (Dublin Core, EDM, SKOS, etc.), technical acronyms (FAIR, CARE, CIDOC-CRM, etc.), and key terms (Bias, Diskriminierung, Interoperabilität, etc.). All metadata field references have been updated to use consistent backtick formatting as requested. Commit: f817064 |
…ments Co-authored-by: maehr <[email protected]>
- Implemented a new Lua script (glossary.lua) to manage glossary terms and definitions, allowing for in-text term highlighting and a glossary table. - Updated _quarto.yml to include glossary configuration options such as path, popup behavior, and visibility. - Removed the existing glossary markdown file (glossar.md) and replaced it with a YAML file (glossary.yaml) containing glossary terms and their definitions. - Modified index.qmd to integrate the glossary feature, including a section for displaying the glossary table. - Deleted notes.md as it contained outdated todos and notes.
- Added JavaScript dependency for glossary popups. - Changed glossary popup trigger from "hover" to "click" for better user interaction. - Implemented Bootstrap popover for glossary terms with unique IDs for accessibility. - Updated CSS for improved image responsiveness and print styles. - Adjusted image attributes in the manuscript for better layout and accessibility. - Revised glossary term definitions and descriptions for clarity and consistency.
This PR implements the repository setup requirements for the Diskriminierungsfreie Metadaten handbook v2.0.0alpha release as specified in issue #32, along with comprehensive documentation improvements based on feedback.
🎯 Overview
The v2.0.0alpha release represents a major overhaul of the handbook and requires proper technical and organizational groundwork. This PR establishes the foundation for sustainable v2 development by implementing proper versioning, branching strategy, and contribution guidelines, while also significantly enhancing the documentation quality and consistency.
📋 Changes Made
🌿 Branch Management
v2.0.0alphabranch for dedicated v2 development📦 Semantic Versioning Implementation
1.0.1to2.0.0-alpha.02.0.0-alpha.0→2.0.0-alpha.1→ ... →2.0.0-beta.0→2.0.0📚 Contribution Guidelines Enhancement
CONTRIBUTING.mdv2/feature/)🔧 Infrastructure Updates
📖 Documentation Quality Improvements
manuscript/glossar.md) with 100+ technical terms and acronymsmanuscript/index.qmdusing backticks (e.g.,dc:title,edm:provider,skos:prefLabel/altLabel,xsd:string@de)OCR,HTR,CER,WER,genderIdentity)🚀 Ready for Development
The repository now provides a clean foundation for v2.0.0alpha development:
Content development and review can now proceed on the
v2.0.0alphabranch with confidence in the underlying technical infrastructure and enhanced documentation quality.🔍 Documentation Enhancement Details
Comprehensive Glossary:
manuscript/glossar.mdwith detailed definitions for metadata standards (Dublin Core, EDM, SKOS, MARC, METS, TEI)Metadata Field Formatting:
Fixes #32
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.