cncf
/
techdocs
mirror of https://github.com/cncf/techdocs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

TechDocs assessments updates (#226) 

* Adding README files to etcd & KEDA assessments. Small correction in Backstage assessment.

Signed-off-by: Nate W <natew@cncf.io>

* Update assessments/0010-etcd/README.md

Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>

* Update assessments/0011-keda/README.md

Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>

* updating with links to repos

Signed-off-by: Nate W <natew@cncf.io>

---------

Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
This commit is contained in:
Nate W 2024-04-22 16:32:14 -07:00 committed by GitHub
parent d760e0c912
commit 0f50086c97
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
assessments/0008-backstage/README.md
View File

@ -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.

8
assessments/0010-etcd/README.md Normal file
View File

@ -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).

2
assessments/0010-etcd/etcd-analysis.md
View File

@ -1,4 +1,4 @@
---
---
title: etcd Documentation Analysis
tags: etcd
created: 2023-09-01

7
assessments/0011-keda/README.md Normal file
View File

@ -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).