Skip to content

docs: add migration.md#386

Open
Satarupa22-SD wants to merge 2 commits intogemaraproj:mainfrom
Satarupa22-SD:add-migration.md
Open

docs: add migration.md#386
Satarupa22-SD wants to merge 2 commits intogemaraproj:mainfrom
Satarupa22-SD:add-migration.md

Conversation

@Satarupa22-SD
Copy link
Copy Markdown
Contributor

@Satarupa22-SD Satarupa22-SD commented Apr 8, 2026

Description

Schema Changes

Schema Changes Made

  • No schema changes
  • Audit Log schema (auditlog.cue) changes
  • Capability Catalog schema (capabilitycatalog.cue) changes
  • Control Catalog schema (controlcatalog.cue) changes
  • Enforcement Log schema (enforcementlog.cue) changes
  • Evaluation Log schema (evaluationlog.cue) changes
  • Guidance Catalog schema (guidancecatalog.cue) changes
  • Mapping Document schema (mappingdocument.cue) changes
  • Policy Document schema (policy.cue) changes
  • Principle Catalog schema (principlecatalog.cue) changes
  • Risk Catalog schema (riskcatalog.cue) changes
  • Threat Catalog schema (threatcatalog.cue) changes
  • Vector Catalog schema (vectorcatalog.cue) changes
  • Other

Schema Change Details

<!-- If applicable, provide a brief summary or example of schema changes -->

Testing

  • Unit tests added/updated
  • Manual testing performed
  • Test data updated (if applicable)

Related Issues

#372

Reviewer Hints


Self-review checklist

  • This PR has content that was created with AI assistance.
  • I have the experience and knowledge necessary to answer maintainer questions about the content of this PR, without using AI.

@Satarupa22-SD Satarupa22-SD requested a review from a team as a code owner April 8, 2026 19:36
@Satarupa22-SD Satarupa22-SD marked this pull request as draft April 8, 2026 19:36
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 8, 2026
Signed-off-by: Satarupa22-SD <satarupa2212@gmail.com>
Comment thread docs/migration.md Outdated
Co-authored-by: Jennifer Power <jpower@redhat.com>
Signed-off-by: Satarupa Deb <84276219+Satarupa22-SD@users.noreply.github.com>
@Satarupa22-SD Satarupa22-SD marked this pull request as ready for review April 15, 2026 21:17
@jpower432 jpower432 requested a review from eddie-knight April 15, 2026 21:26
@jpower432
Copy link
Copy Markdown
Contributor

@eddie-knight Anything missing from this list that you see?

@jpower432 jpower432 added this to the Post v1 Documentation milestone Apr 16, 2026
Comment thread docs/migration.md
**Control Catalog after (#230):**

```yaml
families:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we shouldn't be going change-by-change with the migration guide, since that seems to have lost track of the final state. Not sure whether there are any other deltas, but families became groups by the final v1 release.

https://github.com/gemaraproj/gemara/blob/main/capabilitycatalog.cue#L19

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense. I think it might be good to capture in-between changes that were actually released. Maybe it would be useful if we track individual field changes in the table at the top like:

Before After
families[] groups[]
family[i].controls[] controls[], control.family
metadata.applicability-categories[] metadata.applicability-groups[]

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.

3 participants