Skip to content

Commit 71e7e2b

Browse files
nate-double-unate-double-u
authored
Merge branch 'main' into main
2 parents 3748196 + c6cb637 commit 71e7e2b

31 files changed

+1474
-368
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@
66
# npm assets
77
node_modules/
88
package-lock.json
9+
10+
/tmp

‎.htmltest.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# cSpell:ignore github
2+
CacheExpires: 9000h # ~ 12 months
3+
DirectoryPath: build
4+
TestFilesConcurrently: true
5+
IgnoreDirs:
6+
IgnoreInternalURLs: # list of paths
7+
IgnoreURLs: # list of regexes of URLs or path to be ignored
8+
- \?no-link-check
9+
# FIXME: temporary ignore rules
10+
- assistance\.md
11+
- LICENSE
12+
- /analyses/

‎.markdown-link-check.json

+4
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111
},
1212
{
1313
"pattern": "\\?no-link-check$"
14+
},
15+
{
16+
"why": "Temporary: due to scheduled maintenance",
17+
"pattern": "https://www.usenix.org"
1418
}
1519
],
1620
"timeout": "3s",

‎LICENSE

+398-201
Large diffs are not rendered by default.

‎LICENSE-CODE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎Makefile

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# cSpell:ignore htmltest refcache
2+
# Set REFCACHE to another value to disable htmltest refcache-file manipulation
3+
REFCACHE?=refcache
4+
HTMLTEST_DIR=tmp
5+
HTMLTEST?=htmltest # Specify as make arg if different
6+
HTMLTEST_ARGS?=--log-level 1
7+
LINK_CACHE_FILE?=refcache.json
8+
LINK_CACHE_FILE_DEST_DIR?=static
9+
LINK_CACHE_FILE_SRC_DIR?=$(HTMLTEST_DIR)/.htmltest
10+
11+
# Use $(HTMLTEST) in PATH, if available; otherwise, we'll get a copy
12+
ifeq (, $(shell which $(HTMLTEST)))
13+
override HTMLTEST=$(HTMLTEST_DIR)/bin/htmltest
14+
ifeq (, $(shell which $(HTMLTEST)))
15+
GET_LINK_CHECKER_IF_NEEDED=get-link-checker
16+
endif
17+
endif
18+
19+
default:
20+
@echo "Make what? Target list:\n"
21+
@make -rpn | grep '^[a-z]\S*:' | sed 's/://' | sort
22+
23+
$(LINK_CACHE_FILE_SRC_DIR):
24+
mkdir -p $(LINK_CACHE_FILE_SRC_DIR)
25+
26+
$(LINK_CACHE_FILE_DEST_DIR)/$(LINK_CACHE_FILE):
27+
mkdir -p $(LINK_CACHE_FILE_DEST_DIR)
28+
echo '{}' > $(LINK_CACHE_FILE_DEST_DIR)/$(LINK_CACHE_FILE)
29+
30+
refcache-restore: $(LINK_CACHE_FILE_DEST_DIR)/$(LINK_CACHE_FILE) $(LINK_CACHE_FILE_SRC_DIR)
31+
ifeq (refcache, $(REFCACHE))
32+
cp $(LINK_CACHE_FILE_DEST_DIR)/$(LINK_CACHE_FILE) $(LINK_CACHE_FILE_SRC_DIR)/
33+
else
34+
@echo "SKIPPING refcache-restore"
35+
endif
36+
37+
refcache-save:
38+
ifeq (refcache, $(REFCACHE))
39+
cp $(LINK_CACHE_FILE_SRC_DIR)/$(LINK_CACHE_FILE) $(LINK_CACHE_FILE_DEST_DIR)/
40+
npx prettier --prose-wrap=always --write $(LINK_CACHE_FILE_DEST_DIR)/$(LINK_CACHE_FILE)
41+
else
42+
@echo "SKIPPING refcache-save"
43+
endif
44+
45+
check-links: $(GET_LINK_CHECKER_IF_NEEDED) \
46+
refcache-restore check-links-only refcache-save
47+
48+
check-links-only:
49+
$(HTMLTEST) $(HTMLTEST_ARGS)
50+
51+
clean:
52+
rm -rf $(HTMLTEST_DIR) public/* resources
53+
54+
get-link-checker:
55+
rm -Rf $(HTMLTEST_DIR)/bin
56+
curl https://htmltest.wjdp.uk | bash -s -- -b $(HTMLTEST_DIR)/bin

‎README.md

+29-32
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,29 @@
11
# CNCF TechDocs
22

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

6-
- `docs` contains collected resources for building websites and developing
7-
documentation, including recommended tools and practices, how-tos, and
8-
evaluation checklists. Included are specific guidelines for:
6+
- [Docs](docs) about building websites and developing technical documentation,
7+
including recommended tools, best practices, how-tos, and evaluation
8+
checklists. It provides specific guidelines for:
99
- Setting up and maintaining a documentation website.
1010
- Writing technical documentation for a project.
11-
- Getting assistance from the CNCF TechDocs community.
12-
- Analyzing project documentation, for use by CNCF TechDocs staff (in
13-
`docs/analysis`).
14-
- `analyses` (not to be confused with `docs/analysis`) contains all the
15-
completed documentation analyses.
11+
- Seeking assistance from the CNCF TechDocs community.
12+
- [Analyzing project documentation](docs/analysis/).
13+
- [Analyses](analyses): a collection of documentation analyses of CNCF projects
14+
performed by the TechDocs team.
1615

1716
## TechDocs Q&A
1817

19-
The CNCF tech docs team holds a Zoom call to answer questions and discuss
20-
anything to do with documentation. Calls are held on the [fourth Wednesday of
18+
The CNCF TechDocs team holds a [Zoom meeting][] to answer questions and discuss
19+
anything to do with documentation. Meetings are held on the [fourth Wednesday of
2120
every month at 8am Pacific time][date-time].
2221

23-
TechDocs Q&A (formerly called _Office Hours_) started on 30 September 2020.
22+
- [Zoom meeting][] link
23+
- [Meeting notes][]
2424

25-
### Meeting link
26-
27-
- [Zoom meeting 95471930872]
28-
29-
### Meeting notes
30-
31-
We store ongoing meeting notes in a
32-
[Google doc](https://docs.google.com/document/d/1roexHTLCrErYjNT2NEoRsVnn_YNbQzZ1gyXNK8hXR4Q/).
25+
> <small>Formerly called _Office Hours_, TechDocs Q&amp;A started on September
26+
> 30, 2020.</small>
3327
3428
## Assistance program for technical documentation
3529

@@ -39,22 +33,25 @@ documentation. For details, see the TechDocs
3933

4034
## CNCF TechDocs team
4135

42-
The full-time staff of the CNCF Tech Docs team is:
36+
The full-time staff of the team is (in alphabetical order):
4337

44-
<!-- markdownlint-disable line-length -->
38+
- [Nate Waddington](https://github.com/nate-double-u) - Head of mentoring &
39+
documentation
40+
- [Patrice Chalin](https://github.com/chalin) - Senior techdoc & webdev lead
41+
- [Uchechukwu Obasi](https://github.com/thisisobate) - Developer advocate
4542

46-
| GitHub ID | Role |
47-
| -------------------------------------------------- | ------------------------------------- |
48-
| [@chalin](https://github.com/chalin) | Senior technical writer |
49-
| [@nate-double-u](https://github.com/nate-double-u) | Developer advocate & technical writer |
50-
| [@thisisobate](https://github.com/thisisobate) | Developer advocate |
43+
Consultants and volunteers also contribute to CNCF TechDocs efforts.
5144

52-
<!-- markdownlint-enable line-length -->
53-
<!-- cSpell:ignore chalin nate thisisobate -->
45+
## Licenses
5446

55-
Various consultants and volunteers also contribute to CNCF Tech Docs projects.
47+
- Documentation: [CC-BY-4.0](LICENSE)
48+
- Code: [Apache-2.0](LICENSE-CODE)
5649

5750
[date-time]:
5851
https://tockify.com/cncf.public.events/monthly?search=CNCF%20Tech%20Writers%20Office%20Hours
59-
[Zoom meeting 95471930872]:
52+
[Meeting notes]:
53+
https://docs.google.com/document/d/1roexHTLCrErYjNT2NEoRsVnn_YNbQzZ1gyXNK8hXR4Q/
54+
[Zoom meeting]:
6055
https://zoom-lfx.platform.linuxfoundation.org/meeting/95471930872?password=db1aa715-a60b-444c-8b14-71d44161a42e
56+
57+
<!-- cSpell:ignore Chalin Waddington Uchechukwu Obasi techdoc webdev -->

‎analyses/0002-notary-project.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ Criteria
199199
- Letting new users know where to get help
200200

201201
- Complete the governance work started here:
202-
<https://github.com/notaryproject/specifications/issues/55>
202+
https://github.com/notaryproject/specifications/issues/55
203203
https://github.com/notaryproject/notaryproject/pull/78, and add it to a
204204
governance page (or section) on the website.
205205

0 commit comments

Comments
 (0)