Skip to content

Fix format of analyses, docs, and more #246

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.

Sign up for GitHub

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

Merged
nate-double-u merged 1 commit into from
May 31, 2024
Merged

Fix format of analyses, docs, and more #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 9 additions & 10 deletions .github/settings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,31 +65,31 @@ labels:
- name: p3-low
color: FEF2C0
- name: e0-minutes
description: "Effort: < 60 min"
description: 'Effort: < 60 min'
color: e6ccb3
- name: e1-hours
description: "Effort: < 8 hrs"
description: 'Effort: < 8 hrs'
color: d9b38c
- name: e2-days
description: "Effort: < 5 days"
description: 'Effort: < 5 days'
color: cc9966
- name: e3-weeks
description: "Effort: < 4 weeks"
description: 'Effort: < 4 weeks'
color: bf8040
- name: e4-months
description: "Effort: 1+ months"
description: 'Effort: 1+ months'
color: 996633
- name: Docs Assessment
description: "CNCF TechDocs Assessments"
description: 'CNCF TechDocs Assessments'
color: c2e0c6
- name: Website Update
description: "CNCF Help request for project website updates"
description: 'CNCF Help request for project website updates'
color: BFAFE3
- name: suggested doc
description: "New doc suggestions for the docs/ section"
description: 'New doc suggestions for the docs/ section'
color: 89E295
- name: admin
description: "TechDocs administration activities"
description: 'TechDocs administration activities'
color: 000000
# Default new repo labels
- name: bug
Expand Down Expand Up @@ -122,4 +122,3 @@ labels:
- name: CNCF Service Desk
description: This issue has a related CNCF Service Desk ticket
color: 0CD9EF

9 changes: 1 addition & 8 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1 @@
.github

# temporary

# Until https://github.com/cncf/techdocs/pull/229 is merged
analyses
docs
/README.md
# Nothing to ignore at the moment.
29 changes: 20 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
# CNCF TechDocs

This repository holds resources provided by the CNCF Technical Documentation team. The repo contains the following directories:
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.
- `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.

## CNCF TechDocs team

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

| 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 |
Expand All @@ -21,22 +25,29 @@ Various consultants and volunteers also contribute to CNCF Tech Docs projects.

## Office hours

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

Office hours started on 30 September 2020.

### Meeting link

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

### Meeting notes

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

## Assistance program for technical documentation

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

### Resources

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