diff --git a/assessments/0008-backstage/README.md b/assessments/0008-backstage/README.md index c615e22..dcb57bd 100644 --- a/assessments/0008-backstage/README.md +++ b/assessments/0008-backstage/README.md @@ -3,10 +3,10 @@ title: Backstage TechDocs Analysis tags: backstage --- -- [Backstage Doc Analysis](backstage-analysis.md) - Analyzes the exisitng Backstage documentation and provides recommendations. +- [Backstage Doc Analysis](backstage-analysis.md) - Analyzes the existing Backstage documentation and provides recommendations. - [Backstage Implementation](backstage-implementation.md) - Provides detailed and actionable recommendations, intended to be worked on as GitHub issues. - [User Roles](user-roles.md) - A discussion of Backstage stakeholders with respect to how they use documentation. Folded into the Implementation doc. Reference. - [Backstage Insights Summary](backstage-insights-summary.md) - A summary of conclusions from Spotify's survey of Backstage adopters. Background. -- [Backstage Issues](backstage-issues.md) - A list of documentation improvements derived from Backstage Implementation, to be entered as issues in the backstage/backstage repo. +- [Backstage Issues](backstage-issues.md) - A list of documentation improvements derived from Backstage Implementation, to be entered as issues in the [backstage/backstage repo](https://github.com/backstage/backstage/issues/21893). - [Backstage Docs Survey](backstage-doc-survey.csv) - A spreadsheet of every page of the Backstage technical documentation at the time of the analysis. About 200 lines. - [Backstage Glossary](backstage-glossary.md) - A glossary of terms for the Backstage project, the Backstage product, and this analysis. Edit to use as the Glossary for the Backstage technical documentation. diff --git a/assessments/0010-etcd/README.md b/assessments/0010-etcd/README.md new file mode 100644 index 0000000..d877f01 --- /dev/null +++ b/assessments/0010-etcd/README.md @@ -0,0 +1,8 @@ +--- +title: etcd TechDocs Analysis +tags: etcd +--- + +- [etcd Doc Analysis](etcd-analysis.md) - Analyzes the existing etcd documentation and provides recommendations. +- [etcd Implementation](etcd-implementation.md) - Provides detailed and actionable recommendations, intended to be worked on as GitHub issues. +- [etcd Issues](etcd-issues.md) - A list of documentation improvements derived from etcd Implementation, entered as issues in the [etcd-io/website repo](https://github.com/etcd-io/website/issues/766). diff --git a/assessments/0010-etcd/etcd-analysis.md b/assessments/0010-etcd/etcd-analysis.md index 4d33cd5..e4519e4 100644 --- a/assessments/0010-etcd/etcd-analysis.md +++ b/assessments/0010-etcd/etcd-analysis.md @@ -1,4 +1,4 @@ - --- +--- title: etcd Documentation Analysis tags: etcd created: 2023-09-01 diff --git a/assessments/0011-keda/README.md b/assessments/0011-keda/README.md new file mode 100644 index 0000000..8af27e7 --- /dev/null +++ b/assessments/0011-keda/README.md @@ -0,0 +1,7 @@ +--- +title: KEDA TechDocs Analysis +tags: KEDA +--- +- [KEDA Doc Analysis](keda-analysis.md) - Analyzes the existing KEDA documentation and provides recommendations. +- [KEDA Implementation](keda-implementation.md) - Provides detailed and actionable recommendations, intended to be worked on as GitHub issues. +- [KEDA Issues](keda-issues.md) - A list of documentation improvements derived from KEDA Implementation, entered as issues in the [kedacore/keda-docs repo](https://github.com/kedacore/keda-docs/issues/1361).