Skip to content

Commit 31f8d6f

Browse files
committed
[editorial] Fix format of analyses, docs, and README
- No content changes Signed-off-by: Patrice Chalin <[email protected]>
1 parent 01e6b66 commit 31f8d6f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+5281
-2705
lines changed

.github/settings.yml

+9-10
Original file line numberDiff line numberDiff line change
@@ -65,31 +65,31 @@ labels:
6565
- name: p3-low
6666
color: FEF2C0
6767
- name: e0-minutes
68-
description: "Effort: < 60 min"
68+
description: 'Effort: < 60 min'
6969
color: e6ccb3
7070
- name: e1-hours
71-
description: "Effort: < 8 hrs"
71+
description: 'Effort: < 8 hrs'
7272
color: d9b38c
7373
- name: e2-days
74-
description: "Effort: < 5 days"
74+
description: 'Effort: < 5 days'
7575
color: cc9966
7676
- name: e3-weeks
77-
description: "Effort: < 4 weeks"
77+
description: 'Effort: < 4 weeks'
7878
color: bf8040
7979
- name: e4-months
80-
description: "Effort: 1+ months"
80+
description: 'Effort: 1+ months'
8181
color: 996633
8282
- name: Docs Assessment
83-
description: "CNCF TechDocs Assessments"
83+
description: 'CNCF TechDocs Assessments'
8484
color: c2e0c6
8585
- name: Website Update
86-
description: "CNCF Help request for project website updates"
86+
description: 'CNCF Help request for project website updates'
8787
color: BFAFE3
8888
- name: suggested doc
89-
description: "New doc suggestions for the docs/ section"
89+
description: 'New doc suggestions for the docs/ section'
9090
color: 89E295
9191
- name: admin
92-
description: "TechDocs administration activities"
92+
description: 'TechDocs administration activities'
9393
color: 000000
9494
# Default new repo labels
9595
- name: bug
@@ -122,4 +122,3 @@ labels:
122122
- name: CNCF Service Desk
123123
description: This issue has a related CNCF Service Desk ticket
124124
color: 0CD9EF
125-

.prettierignore

+1-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1 @@
1-
.github
2-
3-
# temporary
4-
5-
# Until https://github.com/cncf/techdocs/pull/229 is merged
6-
analyses
7-
docs
8-
/README.md
1+
# Nothing to ignore at the moment.

README.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
# CNCF TechDocs
22

3-
This repository holds resources provided by the CNCF Technical Documentation team. The repo contains the following directories:
3+
This repository holds resources provided by the CNCF Technical Documentation
4+
team. The repo contains the following directories:
45

5-
- `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.
6-
- `resources` contains information that OSS teams can use to set up a documentation project as suggested by the TechDocs team.
6+
- `analysis` contains instructions, templates, and criteria for requesting and
7+
performing an analysis of an OSS project's website and technical
8+
documentation. Completed analyses are stored here as well.
9+
- `resources` contains information that OSS teams can use to set up a
10+
documentation project as suggested by the TechDocs team.
711

812
## CNCF TechDocs team
913

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

1216
| GitHub ID | Role |
13-
|----------------------------------------------------|---------------------------------------|
17+
| -------------------------------------------------- | ------------------------------------- |
1418
| [@chalin](https://github.com/chalin) | Senior technical writer |
1519
| [@nate-double-u](https://github.com/nate-double-u) | Developer advocate & technical writer |
1620
| [@thisisobate](https://github.com/thisisobate) | Developer advocate |
@@ -21,22 +25,29 @@ Various consultants and volunteers also contribute to CNCF Tech Docs projects.
2125

2226
## Office hours
2327

24-
The CNCF tech docs team holds office hours on the [fourth Wednesday of every month at 8am Pacific time](https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours).
28+
The CNCF tech docs team holds office hours on the
29+
[fourth Wednesday of every month at 8am Pacific time](https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours).
2530

2631
Office hours started on 30 September 2020.
2732

2833
### Meeting link
2934

30-
Zoom link: https://zoom-lfx.platform.linuxfoundation.org/meeting/95471930872?password=db1aa715-a60b-444c-8b14-71d44161a42e
35+
Zoom link:
36+
https://zoom-lfx.platform.linuxfoundation.org/meeting/95471930872?password=db1aa715-a60b-444c-8b14-71d44161a42e
3137

3238
### Meeting notes
3339

34-
We store ongoing meeting notes in a [Google doc](https://docs.google.com/document/d/1roexHTLCrErYjNT2NEoRsVnn_YNbQzZ1gyXNK8hXR4Q/).
40+
We store ongoing meeting notes in a
41+
[Google doc](https://docs.google.com/document/d/1roexHTLCrErYjNT2NEoRsVnn_YNbQzZ1gyXNK8hXR4Q/).
3542

3643
## Assistance program for technical documentation
3744

38-
The TechDocs team can assist CNCF projects analyze and improve their documentation. For details, see the TechDocs [assistance program](docs/assistance.md).
45+
The TechDocs team can assist CNCF projects analyze and improve their
46+
documentation. For details, see the TechDocs
47+
[assistance program](docs/assistance.md).
3948

4049
### Resources
4150

42-
The `docs/` directory contains collected resources for building websites and developing documentation, including recommended tools and practices, how-tos, and evaluation checklists.
51+
The `docs/` directory contains collected resources for building websites and
52+
developing documentation, including recommended tools and practices, how-tos,
53+
and evaluation checklists.

0 commit comments

Comments
 (0)