cncf
/
techdocs
mirror of https://github.com/cncf/techdocs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
130 Commits 2 Branches 0 Tags 1.4 MiB
Commit Graph

130 Commits

Author SHA1 Message Date
Nate W 81199a22ff
Merge pull request #229 from dwelsch-esi/analysis-howto 
Revised TechDoc Analysis Tools
 2024-05-31 09:16:25 -07:00
Patrice Chalin edebb31f76 Address check failures 
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
 2024-05-31 12:13:45 -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 438386fc24 Reverting CSV file. 
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 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 0a855c8f9b Temporarily renamed analyses back to assessments to merge in-toto change 
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
Dave Welsch 9f2938b132 Apply suggestions from code review 
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
 2024-05-31 12:13:45 -04:00
David Welsch f042ad820f Completed first draft of tech doc analysis READMEs, instructions, and templates. Reorganized tech-docs directory structure. 
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 af91f2f50d Updated. 
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
Patrice Chalin 917642768e
Fix GH action errors & Ingore GH handles in README.md (#243) 2024-05-31 11:33:28 -04:00
Patrice Chalin 904b891970
[CI] Run checks over PRs (#235) 
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
 2024-05-27 14:49:20 -07:00
Manish Krishna Kandrakota 5d6363e6c5
fixed Broken embedded link (#237) 2024-05-27 17:28:21 -04:00
Patrice Chalin 69391c5928
Add issue labels `admin` and `meta` (#234) 2024-05-15 12:01:06 -07:00
Patrice Chalin c96c55fdc7
Basic tooling: link & spell chack, and formatting (#231) 
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
 2024-05-14 12:51:08 -07:00
Patrice Chalin e44c02eb40
Add CI/infra label (#233) 
Signed-off-by: Patrice Chalin <chalin@users.noreply.github.com>
 2024-05-14 12:32:06 -07:00
Emmanuel Taiwo e81ca9ab78
Fix some reference links in the assessments/0009-in-toto directory (#230) 2024-05-14 12:43:01 -04:00
Nate W 0f50086c97
TechDocs assessments updates (#226) 
* Adding README files to etcd & KEDA assessments. Small correction in Backstage assessment.

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

* Update assessments/0010-etcd/README.md

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

* Update assessments/0011-keda/README.md

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

* updating with links to repos

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

---------

Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
 2024-04-22 16:32:14 -07:00
Dave Welsch d760e0c912
Keda analysis (#215) 
KEDA documentation analysis, implementation plan, and issues list.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: David Welsch <dw@cluemail.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Co-authored-by: thisisobate <obasiuche62@gmail.com>
Co-authored-by: David Welsch <dw@cluemail.com>
 2024-04-22 15:02:52 -07:00
Nate W c73ed78ae3
updating Office Hours info in README (#223) 
Signed-off-by: Nate W <natew@cncf.io>
 2024-03-28 08:24:05 -07:00
Dave Welsch eb41e5a29e
Final updates to etcd doc analysis (#219) 
* Update etcd-analysis.md

Update etcd-analysis.md to include Kubernetes operator as user role/persona.

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

* Update etcd-implementation.md

Update etcd-implementation.md based on separation of standalone and Kubernetes backstore installation operators.

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

* Update etcd-issues.md

Update etcd-issues.md in response to splitting Operator role to Kubernetes and standalone roles.

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

---------

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
 2024-03-27 11:20:22 -07:00
Dave Welsch 783e1c9a5b
etcd techdoc analysis (#209) 
* Create 0010-etcd/etcd-analysis.md

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

* Updated etcd-analysis.md

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

* In progress

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

* Updates to analysis document.

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

* Updates to analysis and implementation docs.

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

* Completed first draft of analysis and implementation.

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

* Addressed first draft review comments.

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

* Add etcd-issues.md

A list of issues to add to the website repo to implement the doc improvements.

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

* chore: update website section

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

* chore: improve SEO and analytics section

Signed-off-by: thisisobate <obasiuche62@gmail.com>
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: dwelsch-esi <dwelsch@expertsupport.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Co-authored-by: thisisobate <obasiuche62@gmail.com>
 2024-02-12 17:54:46 -08:00
Dave Welsch 1ff55417b7
Update README.md (#208) 
* Update README.md

Add backstage-issues.md to README.

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

* Add Glossary to the Backstage analysis directory

Add a glossary of terms to the Backstage analysis. Can be used as the basis for a comprehensive glossary in the Backstage technical documentation. Contains terms for the Backstage project, the Backstage product, and the CNCF tech doc analysis, so will need editing first. Also: not necessarily complete, but a good starting point.

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

* Add Backstage Glossary to list of docs in README.md

This is the glossary I compiled while doing the tech doc analysis. Can be used as the basis for a glossary in the Backstage documentation, but should be edited first.

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

---------

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
 2024-02-01 15:34:01 -08:00
Dave Welsch 7caea38637
Create backstage-issues.md (#204) 
Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
 2023-11-29 16:20:37 -08:00
Dave Welsch 7944dfb509
Backstage analysis updates (#205) 
Update backstage-analysis

* Removed examples from other projects. Other minor changes.
* Update backstage-implementation.md
* Minor changes to implementation details.

Signed-off-by: Dave Welsch <116022979+dwelsch-esi@users.noreply.github.com>
 2023-11-29 16:09:56 -08:00
Judy Bogart 4172627853
in-toto doc analysis and recommendations (#200) 
Adding in-toto doc assessment.

* Create 0009-iin-toto.md

add doc assessment for initial review

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* add definition of doc champion

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* clarify end-user types

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Expand recommendations, user roles and doc needs

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* further clarify user roles

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* comment w/question on website status 

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* updated the wesite section with appropriate info

Signed-off-by: thisisobate <obasiuche62@gmail.com>

* Address review comments from TechDocs team

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Expand and emphasize actionable recommendations

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Consolidate recommendations, add doc structure summary

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Expand and personalize introductory text

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Create 0009-in-toto.md

Initial draft of new Analysis & Recommendations document for in-toto

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Delete assessments/0009-iin-toto.md

replaced by 0009-in-toto.md

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Add sources of existing doc

* reorganizing in-toto analyisis files

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

* Separate into analysis and implementation docs

* Update assessments/0009-in-toto/in-toto-implementation.md

Co-authored-by: dwelsch-esi <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Update assessments/0009-in-toto/in-toto-implementation.md

Co-authored-by: dwelsch-esi <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Update assessments/0009-in-toto/in-toto-implementation.md

Co-authored-by: dwelsch-esi <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Update assessments/0009-in-toto/in-toto-implementation.md

Co-authored-by: dwelsch-esi <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* move doc survey to separate file

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Create survey-of-existing-doc

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Resolve review comments

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Add date of survey

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Update README.md

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* adjust for new file structure

move general intro to README

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* make first section generally applicable

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* minor edit

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* point to survey and implementation docs

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Update title

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Propose documentation issues to encourage doc contributions

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: dwelsch-esi <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* minor edit

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Update issues

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* Update and rename issues to in-toto-doc-issues.md

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* make issues more distinct

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* add link to proposed issues

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* fix links

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* fix link

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* fix filename

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* fix links

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* fix link

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* fix link

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

* fix formats

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>

---------

Signed-off-by: Judy Bogart <31899326+jbogarthyde@users.noreply.github.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: thisisobate <obasiuche62@gmail.com>
Co-authored-by: Nate W <natew@cncf.io>
Co-authored-by: dwelsch-esi <116022979+dwelsch-esi@users.noreply.github.com>
 2023-11-27 14:29:22 -08:00
dwelsch-esi 6dc3441e63
Create 0008-backstage.md (#189) 
* Create 0008-backstage.md

Added Backstage doc assessment.

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

* Tested documentation build procedure. Updated assessment with findings.

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

* Update Backstage assessment website info

Added information about site mapping based on Docusaurus plugin documentation.

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

* updated the website section with appropriate info

Signed-off-by: thisisobate <obasiuche62@gmail.com>

* Update accessibility section

Signed-off-by: thisisobate <obasiuche62@gmail.com>

* Completed website assessment and recommendations.

Updates and edits to complete the website assessment per @thisisobate.
Other minor edits.

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

* Responses to Backstage doc assessment comments

Responses to initial review comments on the Backstage documentation assesment (0008-backstage.md).

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

* Create user-roles.md

Add a short document to define user roles (personas) for the purpose of organizing task-based documentation.

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

* Move 0008-backstage.md to assessments/0008-backstage

Move to project-specific subdirectory.

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

* Add survey of existing doc pages

Add CSV file: survey of existing Backstage doc web pages. 

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

* Add backstage insights summary doc

Add Backstage Insights summary document describing findings from Spotify's survey about Backstage adoption.

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

* In progress: User roles, recommendations.

* In progress - writing implementation suggestions.

* In progress. Writing implementation recs.

* In progress. Writing Implementation section.

* In progress - fixed external references

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

* Update website action items

Update website recommendation breakdown.

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

* Final changes before merging PR.
  - Separate analysis and implementation.
  - Clean up references.
  - Revise intro material.

* Changes prior to PR merge
  - Separate analysis and implementation
  - Fix references
  - revise intro

* Changes prior to PR merge
  - Separate analysis and implementation
  - Fix references
  - revise intro

* adding README to backstage assessment

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

---------

Signed-off-by: dwelsch-esi <116022979+dwelsch-esi@users.noreply.github.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: thisisobate <obasiuche62@gmail.com>
Co-authored-by: Nate W <natew@cncf.io>
 2023-11-02 13:49:32 -07:00
Nate W 78ef77a70f
updating labels (#185) 
Adding "Website Update" label
Updating "Docs Assessment" label
Updating "documentation" label description

Signed-off-by: Nate W <natew@cncf.io>
 2023-06-21 11:11:04 -07:00
Nate W a2b93ae366
correcting link on TechDocs assessment page (#181) 
Signed-off-by: Nate W <natew@cncf.io>
 2023-05-19 11:13:31 -07:00
Nate W 67d02ffefc
removing Collaborators from settings.yml 
Signed-off-by: Nate W <natew@cncf.io>
 2023-05-18 11:19:17 +01:00
Uchechukwu Obasi f059786584
Docs: Add Porter Docs Assessment (#174) 2023-05-06 12:05:56 -07: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
Nate W 60a8818af3
adding "admin" label, updating "suggested doc" label color away from red hue (#155) 
Signed-off-by: Nate W <natew@cncf.io>
 2022-11-07 17:41:28 -05: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
Nate W 563e827dd2
adding "suggested doc" label for issues and PRs relating to creating a new document in the docs/ section of the repo (#145) 
Signed-off-by: Nate W <natew@cncf.io>
 2022-11-02 17:03:16 -07:00
Nate W 4f4d10a8ff
add nate-double-u to admins (#149) 
Signed-off-by: Nate W <natew@cncf.io>

Signed-off-by: Nate W <natew@cncf.io>
 2022-11-02 18:55:28 -05: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