-
Notifications
You must be signed in to change notification settings - Fork 118
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating CNCF Tech Writing services for projects (#666)
Signed-off-by: Nate W <natew@cncf.io>
- Loading branch information
1 parent
f7435a0
commit cd7f3bd
Showing
1 changed file
with
6 additions
and
5 deletions.
There are no files selected for viewing
11 changes: 6 additions & 5 deletions
11
website/content/resources/project-services/technical-writing/_index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,21 @@ | ||
| --- | ||
| title: Technical Writing | ||
| weight: 3 | ||
| description: Technical writing, analysis, and documentation website services | ||
| --- | ||
|
|
||
| CNCF significant investments per year to improve project documentation. This includes the following services: | ||
| The CNCF makes significant investments each year to improve project documentation. These include the following: | ||
|
|
||
| - Documentation assessments to help projects understand where to make improvements | ||
| - Website hosting and setup | ||
| - [Office hours](https://github.com/cncf/techdocs#office-hours) for face-to-face time with writers | ||
| - [Documentation analysis](https://github.com/cncf/techdocs/tree/main/analyses) to help projects understand where to make improvements—Website hosting and setup | ||
| - [Monthly Q&A sessions](https://github.com/cncf/techdocs#office-hours) for face-to-face time with writers | ||
| - Technical writers and contractors for specific projects | ||
|
|
||
| See [documentation services for projects](https://github.com/cncf/techdocs/blob/main/docs/services.md) for a full description of what the technical documentation team offers. | ||
| For a complete description of the technical documentation team's offerings, see [documentation services for projects](https://github.com/cncf/techdocs/blob/main/docs/services.md). | ||
|
|
||
| Documentation examples include: | ||
|
|
||
| - [Kubernetes](https://kubernetes.io) (i18n support and case studies) | ||
| - [Harbor](https://goharbor.io/) (full redesign) | ||
| - [gRPC](https://grpc.io) (full redesign and contracted tech writing support) | ||
| - [Helm](https://helm.sh) (build pipeline overhaul and i18n support) | ||
|
|