Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: TUF docs Analysis and Improvement #261

Merged
merged 100 commits into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from 99 commits
Commits
Show all changes
100 commits
Select commit Hold shift + click to select a range
03ca321
Docs: Create TUF docs analysis folder
Dindihub Jun 18, 2024
2d97395
Docs: Add content to analysis doc
Dindihub Jun 18, 2024
919bff3
Add signoff in commit
Dindihub Jun 19, 2024
ff59058
Finish analysis of the Project documentation section
Dindihub Jun 20, 2024
e48f0a2
Correct rating on Criteria rubic
Dindihub Jun 20, 2024
38b4dad
Add general comments to Project documentation analysis section
Dindihub Jun 20, 2024
67306a5
Analysis and recommendations of the Contributor documentation section
Dindihub Jun 20, 2024
164d693
Correct Typos on Docs Project documentation section
Dindihub Jun 21, 2024
b40721f
Website and infrastructure section analysis
Dindihub Jun 22, 2024
a239b92
Add implementation strategy to implementation file
Dindihub Jun 25, 2024
f15b7b4
Finish the implementation guide
Dindihub Jun 26, 2024
52ae6d5
correct typos in analysis file
Dindihub Jun 26, 2024
7bf2c75
Remove TUF prefix from file names and trailing slashes
Dindihub Jun 27, 2024
a1bd9a8
Fix broken links
Dindihub Jun 28, 2024
71e18b7
Ran fix:format; fix markdown, copyedits
chalin Jun 30, 2024
ce6ac02
Correct phrases in docs according to rfc standards
Dindihub Jul 1, 2024
aed9a2a
Fix format in md files
Dindihub Jul 1, 2024
a3188a2
Update analyses/0012-TUF/analysis.md
Dindihub Jul 3, 2024
37e1fb4
Update analyses/0012-TUF/analysis.md
Dindihub Jul 3, 2024
da1e64d
Update analyses/0012-TUF/implementation.md
Dindihub Jul 3, 2024
8643888
Add internal links to sections on analysis file and change IA in impl…
Dindihub Jul 5, 2024
e59901b
Remove mention of Docs repo and correct typos
Dindihub Jul 5, 2024
3146379
Remove typos in implementation file
Dindihub Jul 5, 2024
b0e9ac4
Fix formatting issues
Dindihub Jul 5, 2024
ea349fc
Correct typos on implementation.md
Dindihub Jul 7, 2024
d639caa
Fix formatting issues
Dindihub Jul 7, 2024
a1f68c4
Fix formatting issues
Dindihub Jul 7, 2024
19d0395
Fix formatting issues
Dindihub Jul 7, 2024
860f28a
Update analyses/0012-TUF/analysis.md
Dindihub Jul 8, 2024
f1dbeaf
Update analyses/0012-TUF/analysis.md
Dindihub Jul 8, 2024
911e7d0
Update analyses/0012-TUF/analysis.md
Dindihub Jul 8, 2024
b113cd2
Update analyses/0012-TUF/analysis.md
Dindihub Jul 8, 2024
7f0ee4a
Update analyses/0012-TUF/analysis.md
Dindihub Jul 8, 2024
05d2927
Update analyses/0012-TUF/analysis.md
Dindihub Jul 8, 2024
7b2f842
Update analyses/0012-TUF/analysis.md
Dindihub Jul 8, 2024
cdca921
Update analyses/0012-TUF/analysis.md
Dindihub Jul 8, 2024
4223878
Update analyses/0012-TUF/analysis.md
Dindihub Jul 8, 2024
f2d6ac3
Update analyses/0012-TUF/analysis.md
Dindihub Jul 8, 2024
c602015
Update analyses/0012-TUF/implementation.md
Dindihub Jul 8, 2024
61bf85e
Update analyses/0012-TUF/analysis.md
Dindihub Jul 17, 2024
a5da792
Update analyses/0012-TUF/analysis.md
Dindihub Jul 17, 2024
1de2123
Update analyses/0012-TUF/analysis.md
Dindihub Jul 17, 2024
7fd7172
Input Lukas suggestions
Dindihub Jul 17, 2024
3f2bf3b
Merge branch 'TUF-analysis' of https://github.com/Dindihub/techdocs i…
Dindihub Jul 17, 2024
2b0182d
Fix formatting issues
Dindihub Jul 17, 2024
f740bce
Edit text in implementation doc
Dindihub Jul 17, 2024
dfb06fb
Edit text in implementation doc
Dindihub Jul 17, 2024
85ffa92
Edit text in implementation doc
Dindihub Jul 17, 2024
117e3cd
fix formating
Dindihub Jul 17, 2024
5e82188
Edit website docs structure
Dindihub Jul 20, 2024
fb0aa0f
create issues documentation foor TUF
Dindihub Jul 20, 2024
ff2a044
Update users roles subsections in implementation and issue docs
Dindihub Jul 22, 2024
e558ef0
Add README
Dindihub Jul 22, 2024
eb5d918
Add analysis table in implemenation doc
Dindihub Jul 25, 2024
4c99e48
Addd heading to IA table in implementation doc
Dindihub Jul 25, 2024
32b98e1
Update analyses/0012-TUF/README.md
Dindihub Jul 26, 2024
609d8b3
Update analyses/0012-TUF/analysis.md
Dindihub Jul 26, 2024
10b1776
Remove gitpod.yml
Dindihub Jul 26, 2024
06f8d25
Merge branch 'TUF-analysis' of https://github.com/Dindihub/techdocs i…
Dindihub Jul 26, 2024
361a2dc
Fix markdown issues
Dindihub Jul 26, 2024
b9bbd7d
Update analyses/0012-TUF/analysis.md
Dindihub Jul 26, 2024
a4dd60f
Update analyses/0012-TUF/analysis.md
Dindihub Jul 26, 2024
1d795d5
Resolve comments
Dindihub Jul 26, 2024
b1ffc08
Merge branch 'TUF-analysis' of https://github.com/Dindihub/techdocs i…
Dindihub Jul 26, 2024
ff68103
Add suggested improvements to implementation and issue docs
Dindihub Jul 29, 2024
179b614
Update analyses/0012-TUF/analysis.md
Dindihub Jul 17, 2024
d00ae2c
Update analyses/0012-TUF/analysis.md
Dindihub Jul 17, 2024
31a8101
Update analyses/0012-TUF/analysis.md
Dindihub Jul 17, 2024
c799265
Fix formatting issues
Dindihub Jul 17, 2024
b4312ef
Edit text in implementation doc
Dindihub Jul 17, 2024
3661765
Edit text in implementation doc
Dindihub Jul 17, 2024
da7433d
Edit text in implementation doc
Dindihub Jul 17, 2024
d11ea25
fix formating
Dindihub Jul 17, 2024
876d5c7
Edit website docs structure
Dindihub Jul 20, 2024
edf7d7a
create issues documentation foor TUF
Dindihub Jul 20, 2024
d113ffb
Update users roles subsections in implementation and issue docs
Dindihub Jul 22, 2024
6fb2e79
Add README
Dindihub Jul 22, 2024
e377f22
Add analysis table in implemenation doc
Dindihub Jul 25, 2024
103c89a
Addd heading to IA table in implementation doc
Dindihub Jul 25, 2024
32f36b8
Remove gitpod.yml
Dindihub Jul 26, 2024
7da336b
Update analyses/0012-TUF/README.md
Dindihub Jul 26, 2024
0e1f92d
Update analyses/0012-TUF/analysis.md
Dindihub Jul 26, 2024
de12658
Fix markdown issues
Dindihub Jul 26, 2024
6d9c7ba
Resolve comments
Dindihub Jul 26, 2024
0a9a456
Update analyses/0012-TUF/analysis.md
Dindihub Jul 26, 2024
8d53bb1
Update analyses/0012-TUF/analysis.md
Dindihub Jul 26, 2024
8825adf
Add suggested improvements to implementation and issue docs
Dindihub Jul 29, 2024
edd9ae2
resolve merge conflicts
Dindihub Jul 30, 2024
828e791
edit analysis
Dindihub Jul 30, 2024
1d29031
resolve merge conflicts
Dindihub Jul 30, 2024
7b51c26
Resolve merge issues
Dindihub Jul 30, 2024
fad5bda
Addd heading to IA table in implementation doc
Dindihub Jul 25, 2024
9cf2627
Remove gitpod.yml
Dindihub Jul 26, 2024
e0b24db
Resolve comments
Dindihub Jul 26, 2024
5bff9d3
Update analyses/0012-TUF/analysis.md
Dindihub Jul 26, 2024
6a6313b
resolve conflict in issues file
Dindihub Jul 30, 2024
ef60069
resolve merge conflicts
Dindihub Jul 30, 2024
595ecbc
fix table structure in implementation doc
Dindihub Aug 7, 2024
48eba56
Update .gitignore
chalin Aug 9, 2024
84a8c55
Apply suggestions from code review
chalin Aug 9, 2024
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
24 changes: 24 additions & 0 deletions analyses/0012-TUF/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# TUF Documentation Analysis

[Context: "Status: Draft"]
chalin marked this conversation as resolved.
Show resolved Hide resolved

This section contains analysis of The Update Framework (TUF) project
documentation. This is a [CNCF-techdocs](https://github.com/cncf/techdocs) group
process aimed at assisting cloud-native open-source projects with their
documentation efforts.

The documents therein provide an analysis of
[TUF](https://github.com/theupdateframework/theupdateframework.io) existing
website documentation as of June 2024.There are suggested recommendations for
implementation and a list of GitHub Issues. Use the following list to view each
document:

- [TUF Analysis](analysis.md) - Analyzes the existing TUF website documentation
and provides recommendations.

- [TUF Implementation](implementation.md) - Provides detailed and actionable
recommendations.

- [TUF Issues](issues.md) - A list of documentation improvements derived from
TUF Implementation, to be entered as issues in the
[theupdateframework.io repo](https://github.com/theupdateframework/theupdateframework.io).
Loading