Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ pip install -r scripts/requirements-dev.txt
- `model/` — narrative pages: vocabulary, modules, categories overview, references summary.
- `release-notes/` — per-version release notes. Each version subdirectory uses the template at `release-notes/templates/_index.md`.
- `assessment/` — assessment process pages (scoping, assessment, evaluation, reporting, implementation).
- `extensions/` — extension framework schema and the catalog of published extensions.
- `tools/` — Excel-based assessment tools and the web self-assessment configuration.
- `integrations/` — converters that produce artifacts for downstream tools (e.g., Eramba CSV packages).
- `extensions/` — extension framework documentation, structure, scoring, and JSON schema. The catalog of published extensions lives in the separate [`pkimm-extensions`](https://pkic.org/wg/pkimm/extensions/) repository.
- Converters that produce artifacts for downstream tools (e.g., Eramba CSV packages) live in the separate `pkimm-integrations` repository.
- Excel-based assessment tools have been retired in favor of the web self-assessment; the last Excel tools remain available under the `1.0.0` tag / website section.
- `scripts/` — authoring scripts (generator, validator) and their tests.

### Conventions
Expand All @@ -74,7 +74,7 @@ Edit `data/pkimm-model-<version>.yaml` under the relevant module. Use a short ke

### Adding an extension

Each extension is a single YAML file under `extensions/catalog/<id>/<id>-extension.yaml` validating against `extensions/extension.schema-1.0.0.json`. Declare which model versions the extension targets in its `compatibility` array. Extension-specific references go in an inline top-level `references:` block on the extension; common references resolve against the global catalog.
Extension definitions are authored in the separate [`pkimm-extensions`](https://pkic.org/wg/pkimm/extensions/) repository, as a single YAML file per extension validating against this repo's `extensions/extension.schema-1.0.0.json`. Declare which model versions the extension targets in its `compatibility` array. Extension-specific references go in an inline top-level `references:` block on the extension; common references resolve against the global catalog. See the `pkimm-extensions` repository for its authoring workflow.

## License & IPR

Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,5 @@ __pycache__/

### Local Claude Code workspace ###
.claude/
docs/superpowers/
.superpowers/
11 changes: 4 additions & 7 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co

## What this repository is

Content repository for the **PKI Maturity Model (PKIMM)**, maintained by the PKI Consortium PKIMM working group. The content is rendered at https://pkic.org/pkimm by an external Hugo-based site — this repo holds the source markdown, the canonical model data, and assessment tools. There is **no build system, no test suite, and no application code** here. Treat changes as documentation/data edits, not software changes.
Content repository for the **PKI Maturity Model (PKIMM)**, maintained by the PKI Consortium PKIMM working group. The content is rendered at https://pkic.org/pkimm by an external Hugo-based site — this repo holds the source markdown, the canonical model data, and the assessment methodology pages. There is **no build system, no test suite, and no application code** here. Treat changes as documentation/data edits, not software changes.

## Repository layout

Expand All @@ -19,13 +19,10 @@ Content repository for the **PKI Maturity Model (PKIMM)**, maintained by the PKI
- `data/pkimm-model.schema-1.0.0.json` — JSON Schema for the 1.0.0 YAML shape (retroactively renamed from `pkimm-model.schema.json`).
- `data/pkimm-references.yaml` — **independently-versioned references catalog**. Per-requirement `references` fields in the 2.0.0 model contain arrays of IDs from this catalog. Edit here to update reference metadata without touching the model YAML.
- `data/pkimm-references.schema-1.0.0.json` — JSON Schema for the references catalog.
- `extensions/extension.schema-1.0.0.json` — JSON Schema for PKIMM extension files.
- `extensions/catalog/pqc/pqc-extension.yaml` — PQC (Post-Quantum Cryptography) extension version 0.2.0, compatible with PKIMM 2.0.0.
- `extensions/` — extension framework: schema (`extension.schema-1.0.0.json`), structure and scoring documentation. The extension framework defines the non-destructive, composable overlay/relevance model (schema/structure/scoring); the catalog of published extension YAML definitions now lives in the separate `pkimm-extensions` repository, rendered at https://pkic.org/wg/pkimm/extensions/.
- `scripts/` — authoring and validation scripts (see "Authoring workflow" below).
- `tools/` — published Excel assessment tools (`PKI_Maturity_Assessment_Tool_*.xlsx`, `PKI_Maturity_Self_Assessment_Tool_*.xlsx`).
- `integrations/eramba/` — per-schema-version converters that produce Eramba-importable CSV packages.
- `convert-yaml-data-to-csv-package-1.0.0.py` — reads `data/pkimm-model-1.0.0.yaml` (schema 1.0.0) and writes `pkimm-1.0.0.csv`.
- `convert-yaml-data-to-csv-package-2.0.0.py` — reads `data/pkimm-model-2.0.0.yaml` (schema 2.0.0) and `data/pkimm-references.yaml`; writes `pkimm-2.0.0.csv`. Future schema versions get their own script alongside.
- Integration converters (e.g., the Eramba CSV package generators) now live in the separate `pkimm-integrations` repository, rendered at https://pkic.org/wg/pkimm/integrations/.
- The published Excel assessment tools (`PKI_Maturity_Assessment_Tool_*.xlsx`, `PKI_Maturity_Self_Assessment_Tool_*.xlsx`) have been retired from this repo, superseded by the web self-assessment; they remain available via the `1.0.0` tag and the 1.0.0 website section.
- `release-notes/` — per-version release notes (`release-notes/1.0.0/`, `release-notes/2.0.0/`) and a template at `release-notes/templates/`. See the release notes for consumer-facing changes and migration guidance.
- `faq/`, `.github/README.md` — supplementary content; the GitHub-rendered README lives in `.github/README.md`, not the repo root.

Expand Down
2 changes: 1 addition & 1 deletion _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The assessment process defines steps to scope, assess, evaluate, and report the
## Assessment tools

The following assessment tools are available to support the assessment process:
- [PKI maturity assessment tool](./tools/) - Excel spreadsheet that can be used to perform the assessment and generate a report.
- [PKI maturity self-assessment](https://pkic.org/wg/pkimm/assessment/) - web-based self-assessment tool. The earlier Excel-based assessment tool has been retired in favor of this tool and remains available under the 1.0.0 tag / website section.


```mermaid
Expand Down
4 changes: 3 additions & 1 deletion extensions/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Extensions may:

Extensions are optional and independent. They can be added or removed without changing the core PKI MM model or affecting the baseline maturity calculation.

Browse the published extensions in the [extension catalog](https://pkic.org/wg/pkimm/extensions/).

## How extensions influence maturity

> 💡 **Concept**
Expand Down Expand Up @@ -46,6 +48,6 @@ flowchart TD

- **[Extension structure](./structure/)** — what fields make up an extension definition (metadata, Relevance, Overlays). Read this if you are authoring a new extension.
- **[Scoring model](./scoring/)** — formulas, order-of-operations, and the end-to-end worked example. Read this if you are implementing tooling for an extension.
- **[Extension catalog](./catalog/)** — the list of working-group extensions with documentation and YAML definitions.
- **[Extension catalog](https://pkic.org/wg/pkimm/extensions/)** — the list of working-group extensions with documentation and YAML definitions, published from the `pkimm-extensions` repository.
- **[Extension JSON Schema](./extension.schema-1.0.0.json)** — the canonical machine-readable contract for extension YAML files.
- **[Extension framework FAQ](../faq/#extension-framework)** — answers to common questions including non-destructive design, multi-extension behavior, and overlay tunability.
17 changes: 0 additions & 17 deletions extensions/catalog/_index.md

This file was deleted.

116 changes: 0 additions & 116 deletions extensions/catalog/pqc/_index.md

This file was deleted.

Loading