Commit Graph

42 Commits

Author SHA1 Message Date
Patrice Chalin 4433055ced
Docusaurus version of docs pages (#301) 2025-03-17 12:55:23 -04:00
Patrice Chalin 6aafa053ae
Use slack.cncf.io as canonical URL (#300) 2025-03-17 11:45:38 -04:00
Nate W e9225bce00
Add trademark guidance for Series LLCs to website guidelines (#298)
* adding guidance for Series LLCs

Signed-off-by: Nate W <natew@cncf.io>

* Update docs/website-guidelines-checklist.md

Signed-off-by: Nate W <natew@cncf.io>

* Update docs/website-guidelines-checklist.md

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>

* updating formatting after applying edit

Signed-off-by: Nate W <natew@cncf.io>

---------

Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
2025-03-12 15:00:58 -04:00
Nate W 03ebace821
updating domain and netlify information (#299)
* updating domain and netlify information

Signed-off-by: Nate W <natew@cncf.io>

* Update docs/services.md

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>

---------

Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
2025-03-12 16:42:44 +00:00
Dave Welsch 725d0b3e01
Update doc analysis criteria (#286)
* Update criteria to include common findings from the last two years of CNCF doc analyses.

---------

Signed-off-by: Dave Welsch <dwelsch@expertsupport.com>
Signed-off-by: Nate W <natew@cncf.io>
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
Co-authored-by: Nate W <natew@cncf.io>
Co-authored-by: Patrice Chalin <pchalin@gmail.com>
2025-02-26 14:25:49 -08:00
Patrice Chalin 02e2c9e908 [chore] Enable spell-check and fix spelling
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
2025-02-26 14:27:51 -05:00
Patrice Chalin 706bc26d5f
[chore] Fix link fragments (#293) 2025-02-25 14:05:00 -05:00
Patrice Chalin ac83b89179
[CI] Update packages and run checks and fixes (#287) 2025-02-25 12:21:26 -05:00
Dave Welsch 167a9e3441
Sandbox process (#269)
* Added sandbox doc primer

sandbox-doc-primer.md defines terms and outlines a process for getting started with project documentation in CNCF. 

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* fixing formatting

Signed-off-by: Nate W <natew@cncf.io>

* Update sandbox-doc-primer.md

- Added release notes as an example of reference doc
- Added links to more resources
- Minor edits

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* Update sandbox-doc-primer.md

Fixed format issue?

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* Update sandbox-doc-primer.md

Added info about CNCF hosting project websites.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* fixing formatting

Signed-off-by: Nate W <natew@cncf.io>

---------

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: Nate W <natew@cncf.io>
2024-08-07 16:06:12 -07:00
Dave Welsch 3959be809c
Criteria: sandbox update/clarification (#266)
* Update README.md

Corrected with new directory structure. Reorganized description.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* Update criteria.md

Updated sandbox website assessment requirement. Miscellaneous small corrections.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* Update README.md

Fix formatting errors, primarily line legth/LINT.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* Update criteria.md

Fix MD linter and line-length errors.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* Update README.md

Trailing spaces? Really?

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* Update criteria.md

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* Update keda-implementation.md

Fixed faq link

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* Update keda-issues.md

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* fixing formatting issues brought up by prettier

Signed-off-by: Nate W <natew@cncf.io>

* Update docs/analysis/criteria.md

Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>

* Update assistance.md

Added a note to address program differences for projects at the Sandbox maturity level.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

* Update assistance.md

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>

---------

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: Nate W <natew@cncf.io>
2024-07-30 11:58:51 -07:00
Junya Okabe 75cc9b0b96
Initialize the Japanese Localization Guidelines (#259)
* feat: initialize Japanese l10n guide

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* update: add review section

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* fix: anchor link

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* Update: l10n reviewer

Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>
Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* fix: linter errors

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* feat: add ## Localization READMEs

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* fix: link checker error

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* update: .prettierignore

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

* Update docs/localization/README.md

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>

* Update .prettierignore

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>

* fix: L6

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>

---------

Signed-off-by: Junya Okabe <okabe.junya.qj@alumni.tsukuba.ac.jp>
Signed-off-by: Junya Okabe <86868255+Okabe-Junya@users.noreply.github.com>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
2024-07-01 18:05:49 -07:00
Nate W ca2f4e1460
Remove reference to the CNCF Hugo Netlify Starter repo (#258) 2024-06-26 12:49:28 -04:00
Nate W 3f26415261
consolidating /images and /docs/images folders (#250) 2024-06-26 12:46:29 -04:00
Patrice Chalin a15161f612
[CI & docs] Rework of analysis docs + improved checks (#256) 2024-06-12 19:24:16 -04:00
Patrice Chalin 1077d69c90
Update NPM packages, and run Prettier (#251) 2024-06-06 12:58:53 -04:00
Patrice Chalin e06a02dadc
Fix all links in docs and analyses, and rename resources (#248) 2024-05-31 18:16:16 -04:00
Patrice Chalin 31f8d6f787 [editorial] Fix format of analyses, docs, and README
- No content changes

Signed-off-by: Patrice Chalin <pchalin@gmail.com>
2024-05-31 13:18:22 -04:00
Patrice Chalin 01e6b66e91
Move assessments to analyses and more (#245) 2024-05-31 13:08:05 -04:00
Nate W 5f769ae529 correcting links, reformatting tables, other formatting corrections
Signed-off-by: Nate W <natew@cncf.io>
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
2024-05-31 12:13:45 -04:00
David Welsch 836c4636c0 Final (hopefully) changes to the techdoc analysis materials. Directory structure chnages included.
Signed-off-by: David Welsch <dwelsch@expertsupport.com>
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
2024-05-31 12:13:45 -04:00
David Welsch f2b4d9e8c0 Renamed directories, made recommended changes from reviews.
Signed-off-by: David Welsch <dwelsch@expertsupport.com>
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
2024-05-31 12:13:45 -04:00
David Welsch 64bd85724f Updated tech doc analysis process.
Added new analysis templates.
Renamed directories to better reflect their contents.
Rewrote README files.

Signed-off-by: David Welsch <dwelsch@expertsupport.com>
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
2024-05-31 12:13:45 -04:00
Uchechukwu Obasi 5f5199c727
Merge pull request #159 from thisisobate/search-practices-docs
Feat: add new doc for search best practice
2022-11-29 18:02:56 +01:00
thisisobate 926983a72b chore: nit fixes
Signed-off-by: thisisobate <obasiuche62@gmail.com>
2022-11-29 18:02:25 +01:00
thisisobate 716330c326 chore: nit fix
Signed-off-by: thisisobate <obasiuche62@gmail.com>
2022-11-10 16:11:48 +01:00
thisisobate 1ced4bdc8a chore: nit fix
Signed-off-by: thisisobate <obasiuche62@gmail.com>
2022-11-08 20:47:46 +01:00
thisisobate ccb83c90b2 chore: refine contents to be readable
Signed-off-by: thisisobate <obasiuche62@gmail.com>
2022-11-08 20:44:45 +01:00
thisisobate e89e51baeb Feat: add new doc for search best practice
Signed-off-by: thisisobate <obasiuche62@gmail.com>
2022-11-07 21:59:32 +01:00
Rolfe Dlugy-Hegwer 8757907ba7
create l8n folder and readme (#130)
Signed-off-by: Rolfe Dlugy-Hegwer <rolfedh@users.noreply.github.com>
2022-08-30 09:29:16 -07:00
Patrice Chalin 375232d64d
Analytics: explain how to check or manually connect site tags (#131) 2022-08-16 08:39:33 -04:00
Patrice Chalin d876efca47
docs/analytics: move prep steps to Stage 0 (#126) 2022-07-25 18:43:07 -04:00
Patrice Chalin 915ece6fbd
docs/analytics: streamlining process to avoid unnecessary work (#125)
Push the switch to `gtag.js` as late as possible so as to avoid possibly unnecessary work.
2022-07-21 10:15:42 -04:00
Patrice Chalin 262e097c4d
docs/analytics.md: Add note about checkbox (#124) 2022-07-20 12:32:08 -04:00
Patrice Chalin 998c36d336
docs/analytics: what to do when site using analytics.js (#123) 2022-07-16 10:07:05 -04:00
Patrice Chalin 6e201fb125 docs/analytics: factor out UA property rename 2022-07-15 09:14:20 -04:00
Patrice Chalin 0369c53fa0
Analytics-how-to: rework prose into phases, add details (#122) 2022-07-13 07:23:40 -04:00
Patrice Chalin 87a0f9602d
Add migrating instructions from issue (#121) 2022-07-13 06:34:30 -04:00
Patrice Chalin 033acb166f
Create docs/analytics.md
Signed-off-by: Patrice Chalin <chalin@users.noreply.github.com>
2022-07-13 05:52:22 -04:00
Nate W 16c70bbad3
removing ellipsis as it wasn't rendering correctly (#111)
Signed-off-by: Nate W <natew@cncf.io>
2022-06-07 13:47:59 -07:00
Nate W 158043fb4d
Update versioning-documentation.md
Spacing out `⋮` as it wasn't rendering correctly.

Signed-off-by: Nate W. <natew@cncf.io>
2022-06-07 13:44:37 -07:00
Nate W e91d276bb2 moving services file to docs folder. Copy edit of docs/README file
Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
2021-12-07 11:05:05 -08:00
Nate W b1b54b3a0b renaming howto folder docs
Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
2021-12-07 10:02:08 -08:00