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

Add Specification page to TUF analysis IA #272

Closed
wants to merge 95 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
95 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
7fd7172
Input Lukas suggestions
Dindihub Jul 17, 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
6d208a8
Edit text in implementation doc
Dindihub Jul 17, 2024
abc51c3
Edit website docs structure
Dindihub Jul 20, 2024
6dd96dc
create issues documentation foor TUF
Dindihub Jul 20, 2024
68be6df
Update users roles subsections in implementation and issue docs
Dindihub Jul 22, 2024
0ae3536
Add README
Dindihub Jul 22, 2024
edaeeaa
Add analysis table in implemenation doc
Dindihub Jul 25, 2024
4f04b00
Addd heading to IA table in implementation doc
Dindihub Jul 25, 2024
3ad621f
Remove gitpod.yml
Dindihub Jul 26, 2024
58686d2
Update analyses/0012-TUF/README.md
Dindihub Jul 26, 2024
7f91342
Fix markdown issues
Dindihub Jul 26, 2024
1900e7a
Resolve comments
Dindihub Jul 26, 2024
4a6d4bc
Update analyses/0012-TUF/analysis.md
Dindihub Jul 26, 2024
2a9d02f
Add suggested improvements to implementation and issue docs
Dindihub Jul 29, 2024
31817a8
resolve merge conflicts
Dindihub Jul 30, 2024
82c05e2
Resolve merge issues
Dindihub Jul 30, 2024
86f61fe
Addd heading to IA table in implementation doc
Dindihub Jul 25, 2024
40e486f
Remove gitpod.yml
Dindihub Jul 26, 2024
a87b88a
Resolve comments
Dindihub Jul 26, 2024
f07d283
Update analyses/0012-TUF/analysis.md
Dindihub Jul 26, 2024
af6ad44
resolve conflict in issues file
Dindihub Jul 30, 2024
1b63ce6
resolve merge conflicts
Dindihub Jul 30, 2024
4232362
fix table structure in implementation doc
Dindihub Aug 7, 2024
25d6170
Add specs to new IA
Dindihub Aug 9, 2024
3ac3d6c
solve merge conflicts
Dindihub Aug 10, 2024
2bd18ab
resolve merge conflicts
Dindihub Aug 10, 2024
32b9dc5
Initialize the Japanese Localization Guidelines (#259)
Okabe-Junya Jul 2, 2024
e47cb35
Fix broken link from Keda analysis (#268)
chalin Jul 29, 2024
f6c3e97
Criteria: sandbox update/clarification (#266)
dwelsch-esi Jul 30, 2024
552c917
Sandbox process (#269)
dwelsch-esi Aug 7, 2024
0ed4ff9
Docs: TUF docs Analysis and Improvement (#261)
Dindihub Aug 9, 2024
4a70b00
fix merge conflicts
Dindihub Aug 10, 2024
801729d
fix merge conflicts
Dindihub Aug 10, 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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# npm assets
node_modules/
package-lock.json
.gitpod.yml
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Nothing to ignore at the moment.
/docs/localization/ja
62 changes: 31 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,24 @@
This repository holds resources provided by the CNCF Technical Documentation
team. The repo contains the following directories:

- `analysis` contains instructions, templates, and criteria for requesting and
performing an analysis of an OSS project's website and technical
documentation. Completed analyses are stored here as well.
- `resources` contains information that OSS teams can use to set up a
documentation project as suggested by the TechDocs team.
- `docs` contains collected resources for building websites and developing
documentation, including recommended tools and practices, how-tos, and
evaluation checklists. Included are specific guidelines for:
- Setting up and maintaining a documentation website.
- Writing technical documentation for a project.
- Getting assistance from the CNCF TechDocs community.
- Analyzing project documentation, for use by CNCF TechDocs staff (in
`docs/analysis`).
- `analyses` (not to be confused with `docs/analysis`) contains all the
completed documentation analyses.

## CNCF TechDocs team

The full-time staff of the CNCF Tech Docs team is:

<!-- markdownlint-disable line-length -->

| GitHub ID | Role |
| -------------------------------------------------- | ------------------------------------- |
| [@chalin](https://github.com/chalin) | Senior technical writer |
| [@nate-double-u](https://github.com/nate-double-u) | Developer advocate & technical writer |
| [@thisisobate](https://github.com/thisisobate) | Developer advocate |

<!-- markdownlint-enable line-length -->
<!-- cSpell:ignore chalin nate thisisobate -->

Various consultants and volunteers also contribute to CNCF Tech Docs projects.
## TechDocs Q&A

## Office hours
The CNCF tech docs team holds a Zoom call to answer questions and discuss
anything to do with documentation. Calls are held on the [fourth Wednesday of
every month at 8am Pacific time][date-time].

The CNCF tech docs team holds office hours on the [fourth Wednesday of every
month at 8am Pacific time][date-time].

Office hours started on 30 September 2020.
TechDocs Q&A (formerly called _Office Hours_) started on 30 September 2020.

### Meeting link

Expand All @@ -44,15 +33,26 @@ We store ongoing meeting notes in a

## Assistance program for technical documentation

The TechDocs team can assist CNCF projects analyze and improve their
The TechDocs team can help CNCF projects analyze and improve their
documentation. For details, see the TechDocs
[assistance program](docs/assistance.md).

### Resources
## CNCF TechDocs team

The full-time staff of the CNCF Tech Docs team is:

<!-- markdownlint-disable line-length -->

| GitHub ID | Role |
| -------------------------------------------------- | ------------------------------------- |
| [@chalin](https://github.com/chalin) | Senior technical writer |
| [@nate-double-u](https://github.com/nate-double-u) | Developer advocate & technical writer |
| [@thisisobate](https://github.com/thisisobate) | Developer advocate |

<!-- markdownlint-enable line-length -->
<!-- cSpell:ignore chalin nate thisisobate -->

The `docs/` directory contains collected resources for building websites and
developing documentation, including recommended tools and practices, how-tos,
and evaluation checklists.
Various consultants and volunteers also contribute to CNCF Tech Docs projects.

[date-time]:
https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours
Expand Down
2 changes: 1 addition & 1 deletion analyses/0011-keda/keda-implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Here is a proposed outline for the tech doc Table of Contents:
- [Events](https://keda.sh/docs/2.13/operate/events/)
- [Firewall requirements](https://keda.sh/docs/2.13/operate/cluster/#firewall)
- ...
- [FAQ](https://keda.sh/docs/2.13/faq/)
- [FAQ](https://keda.sh/docs/2.13/reference/faq/)
- Glossary
- [Scalers](https://keda.sh/docs/2.13/scalers/)
- [ActiveMQ](https://keda.sh/docs/2.13/scalers/activemq/)
Expand Down
2 changes: 1 addition & 1 deletion analyses/0011-keda/keda-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ or provide a starting point.
- [Events](https://keda.sh/docs/2.13/operate/events/)
- [Firewall requirements](https://keda.sh/docs/2.13/operate/cluster/#firewall)
- ...
- [FAQ](https://keda.sh/docs/2.13/faq/)
- [FAQ](https://keda.sh/docs/2.13/reference/faq/)
- Glossary

# Separate reference and task information
Expand Down
22 changes: 22 additions & 0 deletions analyses/0012-TUF/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# TUF Documentation Analysis

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