Skip to content

Commit

Permalink
fixing formatting issues brought up by prettier
Browse files Browse the repository at this point in the history
Signed-off-by: Nate W <[email protected]>
  • Loading branch information
nate-double-u committed Jul 26, 2024
1 parent 8ca8f4e commit c8e3ec7
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ This repository holds resources provided by the CNCF Technical Documentation
team. The repo contains the following directories:

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

## TechDocs Q&A

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].
anything to do with documentation. Calls are held on the [fourth Wednesday of
every month at 8am Pacific time][date-time].

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

### Meeting link

Expand Down
18 changes: 9 additions & 9 deletions docs/analysis/criteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,14 +190,14 @@ requirements for sandbox projects.
this maturity level to link out to documentation that hasn't yet been
integrated into the website
- _Example_: website with a single homepage, without any documentation or,
as was mentioned above, linking out to an external (preexisting) source for
docs
as was mentioned above, linking out to an external (preexisting) source
for docs
- _However_: consider reading the recommended practices in this repository
and implementing as many of the best practices as you can. This groundwork
will pay big dividends later when you need to upgrade your practices and
update your documentation as an incubating project. Assistance is available
from CNCF TechDocs anytime, including answers to individual questions or a
documentation workshop.
and implementing as many of the best practices as you can. This groundwork
will pay big dividends later when you need to upgrade your practices and
update your documentation as an incubating project. Assistance is
available from CNCF TechDocs anytime, including answers to individual
questions or a documentation workshop.
- **Incubating**
- [Website guidelines][]: all guidelines are satisfied.
- [Docs assessment][]: request an (re-)assessment through the CNCF [service
Expand Down Expand Up @@ -289,8 +289,8 @@ Examples:

### SEO, Analytics and site-local search

SEO helps users find your project and its documentation, and analytics helps
you monitor site traffic and diagnose issues like page 404s. Intra-site search,
SEO helps users find your project and its documentation, and analytics helps you
monitor site traffic and diagnose issues like page 404s. Intra-site search,
while optional, offers your readers site-focused search results and is strongly
recommended.

Expand Down

0 comments on commit c8e3ec7

Please sign in to comment.