Skip to content

Security & Trust Documentation #886

@morri-son

Description

@morri-son

Description
Split tutorials/signing-and-verification.md which mixes concept + how-to content. Extract trust/crypto concepts, create focused how-tos. Remove signing + verification from getting-started guides as they rely on concept/tutorials for key pair handling. They will appear in the how-to section.

Tasks:

  • content/docs/concepts/signing-verification-concept.md (NEW concept) - split from existing tutorial. Trust models, signature types, encoding etc.
  • content/docs/how-to/sign-component-version.md (REWORK existing doc in NEW How-to) - Prerequisites → key config → sign steps → multi-env → troubleshooting
  • content/docs/how-to/verify-component-version.md (REWORK existing doc in NEW How-to) - Prerequisites → key config → verify steps → troubleshooting
  • content/docs/tutorials/signing-and-verification.md (REWORK tutorial) - Split off content spli into concept + how-tos. Keep tutorial with full end-2-end scenario in parallel to small how-tos
  • content/docs/how-to/generate-signing-keys.md (NEW How-to) - Extract content from existing tutorial with focus on key pair creation
  • content/docs/how-to/configure-signing-credentials (NEW How-to) - Extract content from existing tutorial with focus on credential config in .ocmconfig and signer config.

Done Criteria

  • Concept doc: signing + verification
  • How-tos:
    • sign component
    • verify component
    • generate key-pair
    • configure credentials for signing
  • Getting-started guides removed in favor of new how-tos
  • No duplicate content
  • All relrefs updated

Metadata

Metadata

Assignees

Labels

area/documentationDocumentation relatedarea/ipceiImportant Project of Common European Interestkind/tasksmall task, normally part of feature or epic

Type

No type
No fields configured for issues without a type.

Projects

Status
🔍 Review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions