Skip to content

make the repository and management more user friendlyΒ #2

Description

@burespe1

πŸ“ž Repository Refactor & Maintenance Plan β€” Notes from Call (22.9.2025, PB-ME)

🧱 Repository Structure Simplification

The current structure is overly complex. We agreed to streamline it by:

  • Retaining only drafts and releases folders
  • Moving code and images into drafts and releases
  • Relocating vocab into a separate branch (developer)
  • Relocating preview into a separate branch (gh-pages)
  • Moving all root-level coding files into the developer branch
  • Hiding automation by moving it into the developer branch

πŸ“˜ Textual Content Redraft

To improve accessibility and clarity for data dictionary users:

  • Rewrite the README to shift focus from developers to data dictionary enthusiasts
  • Use the index file as the central entry point for data definitions cleanup
  • Add documentation on how branches are structured and used

🌿 Branch Strategy

We need to work more intentionally with branches:

  • Create a gh-pages branch to publish drafts, releases, and the index
  • Automate the creation of gh-pages and document it in the README
  • Create a developer branch for all coding-related work (scripts, automation, etc.)

πŸ“š Vocabulary Maintenance

We need to decide on the long-term strategy for maintaining vocabulary definitions:

  • Choose between two approaches:
    • Option 1: SharePoint + Word document
    • Option 2: GitHub issues + discussions
  • Document how each approach works and how they can be synchronized
    • Likely: revisions from Word copied into GitHub discussions
  • Decide on the timing strategy: sequential vs parallel maintenance

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions