diff --git a/.github/settings.yml b/.github/settings.yml index 62a1acf..6c575c0 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -125,4 +125,3 @@ labels: - name: CNCF Service Desk description: This issue has a related CNCF Service Desk ticket color: 0CD9EF - diff --git a/analyses/0001-contour.md b/analyses/2021/contour/analysis.md similarity index 100% rename from analyses/0001-contour.md rename to analyses/2021/contour/analysis.md diff --git a/analyses/0005-fluxcd.md b/analyses/2021/fluxcd/analysis.md similarity index 100% rename from analyses/0005-fluxcd.md rename to analyses/2021/fluxcd/analysis.md diff --git a/analyses/0003-krator.md b/analyses/2021/krator/analysis.md similarity index 100% rename from analyses/0003-krator.md rename to analyses/2021/krator/analysis.md diff --git a/analyses/0006-gateway-api.md b/analyses/2021/kubernetes-gateway-api/analysis.md similarity index 100% rename from analyses/0006-gateway-api.md rename to analyses/2021/kubernetes-gateway-api/analysis.md diff --git a/analyses/0002-notary-project.md b/analyses/2021/notary/analysis.md similarity index 100% rename from analyses/0002-notary-project.md rename to analyses/2021/notary/analysis.md diff --git a/analyses/0004-tremor.md b/analyses/2021/tremor/analysis.md similarity index 100% rename from analyses/0004-tremor.md rename to analyses/2021/tremor/analysis.md diff --git a/analyses/0008-backstage/backstage-analysis.md b/analyses/2023/backstage/backstage-analysis.md similarity index 100% rename from analyses/0008-backstage/backstage-analysis.md rename to analyses/2023/backstage/backstage-analysis.md diff --git a/analyses/0008-backstage/backstage-doc-survey.csv b/analyses/2023/backstage/backstage-doc-survey.csv similarity index 100% rename from analyses/0008-backstage/backstage-doc-survey.csv rename to analyses/2023/backstage/backstage-doc-survey.csv diff --git a/analyses/0008-backstage/backstage-glossary.md b/analyses/2023/backstage/backstage-glossary.md similarity index 100% rename from analyses/0008-backstage/backstage-glossary.md rename to analyses/2023/backstage/backstage-glossary.md diff --git a/analyses/0008-backstage/backstage-implementation.md b/analyses/2023/backstage/backstage-implementation.md similarity index 100% rename from analyses/0008-backstage/backstage-implementation.md rename to analyses/2023/backstage/backstage-implementation.md diff --git a/analyses/0008-backstage/backstage-insights-summary.md b/analyses/2023/backstage/backstage-insights-summary.md similarity index 100% rename from analyses/0008-backstage/backstage-insights-summary.md rename to analyses/2023/backstage/backstage-insights-summary.md diff --git a/analyses/0008-backstage/backstage-issues.md b/analyses/2023/backstage/backstage-issues.md similarity index 100% rename from analyses/0008-backstage/backstage-issues.md rename to analyses/2023/backstage/backstage-issues.md diff --git a/analyses/0008-backstage/index.md b/analyses/2023/backstage/index.md similarity index 100% rename from analyses/0008-backstage/index.md rename to analyses/2023/backstage/index.md diff --git a/analyses/0008-backstage/user-roles.md b/analyses/2023/backstage/user-roles.md similarity index 100% rename from analyses/0008-backstage/user-roles.md rename to analyses/2023/backstage/user-roles.md diff --git a/analyses/0010-etcd/etcd-analysis.md b/analyses/2023/etcd/etcd-analysis.md similarity index 100% rename from analyses/0010-etcd/etcd-analysis.md rename to analyses/2023/etcd/etcd-analysis.md diff --git a/analyses/0010-etcd/etcd-implementation.md b/analyses/2023/etcd/etcd-implementation.md similarity index 100% rename from analyses/0010-etcd/etcd-implementation.md rename to analyses/2023/etcd/etcd-implementation.md diff --git a/analyses/0010-etcd/etcd-issues.md b/analyses/2023/etcd/etcd-issues.md similarity index 100% rename from analyses/0010-etcd/etcd-issues.md rename to analyses/2023/etcd/etcd-issues.md diff --git a/analyses/0010-etcd/index.md b/analyses/2023/etcd/index.md similarity index 100% rename from analyses/0010-etcd/index.md rename to analyses/2023/etcd/index.md diff --git a/analyses/0009-in-toto/in-toto-analysis.md b/analyses/2023/in-toto/in-toto-analysis.md similarity index 100% rename from analyses/0009-in-toto/in-toto-analysis.md rename to analyses/2023/in-toto/in-toto-analysis.md diff --git a/analyses/0009-in-toto/in-toto-doc-issues.md b/analyses/2023/in-toto/in-toto-doc-issues.md similarity index 100% rename from analyses/0009-in-toto/in-toto-doc-issues.md rename to analyses/2023/in-toto/in-toto-doc-issues.md diff --git a/analyses/0009-in-toto/in-toto-implementation.md b/analyses/2023/in-toto/in-toto-implementation.md similarity index 100% rename from analyses/0009-in-toto/in-toto-implementation.md rename to analyses/2023/in-toto/in-toto-implementation.md diff --git a/analyses/0009-in-toto/index.md b/analyses/2023/in-toto/index.md similarity index 100% rename from analyses/0009-in-toto/index.md rename to analyses/2023/in-toto/index.md diff --git a/analyses/0009-in-toto/survey-of-existing-doc.md b/analyses/2023/in-toto/survey-of-existing-doc.md similarity index 100% rename from analyses/0009-in-toto/survey-of-existing-doc.md rename to analyses/2023/in-toto/survey-of-existing-doc.md diff --git a/analyses/0007-porter.md b/analyses/2023/porter/analysis.md similarity index 100% rename from analyses/0007-porter.md rename to analyses/2023/porter/analysis.md diff --git a/analyses/0012-TUF/analysis.md b/analyses/2024/TUF/analysis.md similarity index 100% rename from analyses/0012-TUF/analysis.md rename to analyses/2024/TUF/analysis.md diff --git a/analyses/0012-TUF/implementation.md b/analyses/2024/TUF/implementation.md similarity index 100% rename from analyses/0012-TUF/implementation.md rename to analyses/2024/TUF/implementation.md diff --git a/analyses/0012-TUF/index.md b/analyses/2024/TUF/index.md similarity index 100% rename from analyses/0012-TUF/index.md rename to analyses/2024/TUF/index.md diff --git a/analyses/0012-TUF/issues.md b/analyses/2024/TUF/issues.md similarity index 100% rename from analyses/0012-TUF/issues.md rename to analyses/2024/TUF/issues.md diff --git a/analyses/0011-keda/index.md b/analyses/2024/keda/index.md similarity index 100% rename from analyses/0011-keda/index.md rename to analyses/2024/keda/index.md diff --git a/analyses/0011-keda/keda-analysis.md b/analyses/2024/keda/keda-analysis.md similarity index 100% rename from analyses/0011-keda/keda-analysis.md rename to analyses/2024/keda/keda-analysis.md diff --git a/analyses/0011-keda/keda-implementation.md b/analyses/2024/keda/keda-implementation.md similarity index 100% rename from analyses/0011-keda/keda-implementation.md rename to analyses/2024/keda/keda-implementation.md diff --git a/analyses/0011-keda/keda-issues.md b/analyses/2024/keda/keda-issues.md similarity index 100% rename from analyses/0011-keda/keda-issues.md rename to analyses/2024/keda/keda-issues.md diff --git a/analyses/0013-litmuschaos/litmuschaos-analysis.md b/analyses/2024/litmuschaos/litmuschaos-analysis.md similarity index 100% rename from analyses/0013-litmuschaos/litmuschaos-analysis.md rename to analyses/2024/litmuschaos/litmuschaos-analysis.md diff --git a/analyses/0013-litmuschaos/litmuschaos-implementation.md b/analyses/2024/litmuschaos/litmuschaos-implementation.md similarity index 100% rename from analyses/0013-litmuschaos/litmuschaos-implementation.md rename to analyses/2024/litmuschaos/litmuschaos-implementation.md diff --git a/analyses/0013-litmuschaos/litmuschaos-issues.md b/analyses/2024/litmuschaos/litmuschaos-issues.md similarity index 100% rename from analyses/0013-litmuschaos/litmuschaos-issues.md rename to analyses/2024/litmuschaos/litmuschaos-issues.md diff --git a/analyses/0016-helm/helm-analysis.md b/analyses/2025/helm/helm-analysis.md similarity index 100% rename from analyses/0016-helm/helm-analysis.md rename to analyses/2025/helm/helm-analysis.md diff --git a/analyses/0016-helm/helm-implementation.md b/analyses/2025/helm/helm-implementation.md similarity index 100% rename from analyses/0016-helm/helm-implementation.md rename to analyses/2025/helm/helm-implementation.md diff --git a/analyses/0016-helm/helm-issues-list.md b/analyses/2025/helm/helm-issues-list.md similarity index 100% rename from analyses/0016-helm/helm-issues-list.md rename to analyses/2025/helm/helm-issues-list.md diff --git a/analyses/0015-knative/analysis.md b/analyses/2025/knative/analysis.md similarity index 100% rename from analyses/0015-knative/analysis.md rename to analyses/2025/knative/analysis.md diff --git a/analyses/0015-knative/issues.md b/analyses/2025/knative/issues.md similarity index 100% rename from analyses/0015-knative/issues.md rename to analyses/2025/knative/issues.md diff --git a/analyses/0014-vitess/analysis.md b/analyses/2025/vitess/analysis.md similarity index 100% rename from analyses/0014-vitess/analysis.md rename to analyses/2025/vitess/analysis.md diff --git a/analyses/index.md b/analyses/index.md index e4c9eae..8f3ba9e 100644 --- a/analyses/index.md +++ b/analyses/index.md @@ -50,11 +50,11 @@ This directory contains completed analyses of the technical documentation for selected CNCF incubating and graduated software projects. The analyses are in one of two formats depending on when they were written. -Earlier analyses (**0001** - **0007**) are Markdown files, each of which is the -sole artifact of the analysis. +Earlier analyses (**2021**) have one project directory per project, and each of +those directories contains a single Markdown file as the only analysis artifact. -Subsequent analyses (**0008-** forward) each have their own directory containing -three analysis artifacts: +Subsequent analyses (**2023** onward) also use one directory per project, with +each directory containing one or more of these three artifact types: - [analysis.md](../docs/analysis/templates/analysis.md) evaluates the project documentation and provides comments and recommendations in a manner very diff --git a/package.json b/package.json index d41d791..a9bd975 100644 --- a/package.json +++ b/package.json @@ -14,8 +14,8 @@ "_check:markdown:all": "npm run -s _list:check:md | xargs -I {} -P 4 npx -p markdownlint-cli markdownlint -c .markdownlint.yaml {}", "_check:markdown:delta": "npm run -s _list:git:delta | xargs -I {} npx -p markdownlint-cli markdownlint -c .markdownlint.yaml {}", "_list:check:*": "npm run --loglevel=warn | grep -Ee '^\\s*check:[^:]+$'", - "_list:check:md:no-analysis": "find . -name '*.md' -not -path '*/node_modules/*' -a -not -path '*/.?*' -a -not -path '*/00*'", - "_list:check:md": "find . -name '*.md' -not -path '*/node_modules/*' -a -not -path '*/.?*' | grep -Eve '/000|/0010'", + "_list:check:md:no-analysis": "find . -name '*.md' -not -path '*/node_modules/*' -a -not -path '*/.?*' -a -not -path './analyses/*'", + "_list:check:md": "find . -name '*.md' -not -path '*/node_modules/*' -a -not -path '*/.?*' -a -not -path './analyses/*'", "_list:fix:*": "npm run --loglevel=warn | grep -Ee '^\\s*fix:[^:]+$' | grep -v 'fix:all'", "_list:git:delta": "git diff --name-only --diff-filter=ACMR | grep -E '\\.(js|md|scss|yml|yaml)$'", "build:preview": "npm run _build",