Skip to content

Restructure repository to support multiple ontology modules - #15

Open
aigora-de wants to merge 4 commits into
mainfrom
restructure-for-multi-module
Open

aigora-de wants to merge 4 commits into
mainfrom
restructure-for-multi-module

Conversation

@aigora-de

@aigora-de aigora-de commented Jan 25, 2026

Copy link
Copy Markdown
Contributor

This pull request is "suspended" until a plan for addressing the issues raised is made and resources assigned. It is also dependent on PR #17 being completed first

Restructure Repository for Multi-Module Support

Closes #1

Summary

This PR restructures the ont-ies repository to support publishing multiple IES ontology modules across different domains. The current flat structure under docs/ only supports IES Common; this change introduces a modular architecture that can accommodate additional domain modules (e.g., IES Building, SDNP modules) as they are developed.

Changes Made

New Files Created

  • registry.yml — Machine-readable index of all published modules
  • RELEASES.md — Documentation for composite releases (tested module combinations)
  • docs/common/module.yml — Module metadata for IES Common
  • docs/common/CHANGELOG.md — Module-specific changelog (content from root CHANGELOG.md)
  • docs/common/specification/index.md — Updated specification landing page
  • docs/common/examples/index.md — Updated examples landing page
  • docs/common/user-guides/index.md — Updated user guides landing page

Files Updated

  • README.md — Updated with new repository structure documentation
  • docs/index.md — Updated to serve as landing page for all modules

Files Removed

  • VERSION — Version info now in docs/common/module.yml
  • CHANGELOG.md — Content moved to docs/common/CHANGELOG.md

Target Structure

After migration is complete:

docs/
├── index.md                    # Documentation landing page
├── glossary.md                 # Shared glossary
├── assets/                     # Shared assets
└── common/                     # IES Common module
    ├── specification/
    │   ├── ies-common.ttl
    │   ├── ies-common.rdf
    │   ├── ies-common.json
    │   ├── ies-common.n3
    │   ├── ies-common.shacl
    │   ├── ies.md
    │   └── index.md
    ├── examples/
    │   ├── ies-examples.md
    │   ├── sample-data/
    │   └── index.md
    ├── user-guides/
    │   └── [user guide files]
    ├── module.yml
    └── CHANGELOG.md

Versioning Strategy

This PR implements the agreed versioning approach:

  • Module tags: {module-id}/v{version} (e.g., common/v5.0.0)
  • Release candidates: {module-id}/v{version}-rcN
  • Composite releases: ies-release-{yyyy.mm}
  • Maintenance branches: {module-id}/v{major}.x (created when needed)

@aigora-de aigora-de added the documentation Improvements or additions to documentation label Jan 25, 2026
@aigora-de aigora-de self-assigned this Jan 25, 2026
@aigora-de aigora-de linked an issue Jan 25, 2026 that may be closed by this pull request
8 tasks
@aigora-de

Copy link
Copy Markdown
Contributor Author

This pull request is "suspended" until a plan for addressing the issues raised is made and resources assigned. It is also dependent on PR #17 being completed first

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Restructure repository to support multiple ontology modules v5.0.0-rc1

1 participant