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

Fix some reference links in the assessments/0009-in-toto directory (#230)

This commit is contained in:
Emmanuel Taiwo 2024-05-14 17:43:01 +01:00 committed by GitHub
parent 0f50086c97
commit e81ca9ab78
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
assessments/0009-in-toto/README.md
View File

@ -20,7 +20,7 @@ This is an actionable plan for doc improvement, with specific implementation rec
The analysis and recommendations for the in-toto project documentation are presented in these files:
- [Survey of existing documentation](./survey-of-existing-doc) (as of September 2023)
- [Survey of existing documentation](./survey-of-existing-doc.md) (as of September 2023)
- [Analysis](./in-toto-analysis.md)
- [Recommendations and implementation](./in-toto-implementation.md)
- [Proposed actionable issues](./in-toto-doc-issues.md)

2
assessments/0009-in-toto/in-toto-analysis.md
View File

@ -1,7 +1,7 @@
# Analysis of Existing Documentation
This document characterizes the effectiveness and completeness of the in-toto open source software (OSS) project's documentation and website as of September 2023. Documentation is analyzed with respect to CNCF criteria for completeness, discoverability, and usability.
The analysis forms the basis for the recommendations and doc plan presented in the companion document, [(../in-toto-implementation.md)].
The analysis forms the basis for the recommendations and doc plan presented in the companion [Implementation document](./in-toto-implementation.md).
## Scope of analysis
The documentation discussed here includes the contents of the website at https://in-toto.io and https://in-toto.readthedocs.io/, the [in-toto Specification](https://github.com/in-toto/docs/tree/master/in-toto-spec.md), and the documentation for contributors and users in the various GitHub repositories at https://github.com/in-toto. See [Survey of existing documentation](./survey-of-existing-doc.md).