CNCF TechDocs Assistance issues tracker

[nate-double-u]

This issue tracks all the issues generated by the TechDocs assistance program.

If your project is interested in working with the TechDocs team on an analysis of your docs, please open a support desk ticket.

Backstage

Backstage Analysis
Contributing to Backstage

• Umbrella Issue: CNCF Tech Doc Recommendations backstage/backstage#21893
• 🚀 Feature: Getting Started documentation backstage/backstage#21828
• 🚀 Feature: Rewrite standalone installation instructions backstage/backstage#21913
• 🚀 Feature: Write production installation instructions backstage/backstage#21915
• 🚀 Feature: Write start and stop instructions for production Backstage server backstage/backstage#21916
• 🚀 Feature: Write instructions for installing and configuring plugins backstage/backstage#21920
• 🚀 Feature: Write a guide to upgrading Backstage backstage/backstage#21921
• 🚀 Feature: Write a database guide for Backstage backstage/backstage#21922
• 🚀 Feature: Write an Admin Guide backstage/backstage#21923
• 🚀 Feature: Rewrite technical overview backstage/backstage#21925
• 🚀 Feature: Rewrite architectural overview backstage/backstage#21926
• 🚀 Feature: Write a getting started guide for developers backstage/backstage#21942
• 🚀 Feature: Write a UI guide backstage/backstage#21943
• 🚀 Feature: Write a Developer Guide backstage/backstage#21944
• 🚀 Feature: Write an integrator guide backstage/backstage#21945
• 🚀 Feature: Reorganize Table of Contents backstage/backstage#21946
• 🚀 Feature: Compile a glossary backstage/backstage#22001
• 🚀 Feature: Website - Write case studies backstage/backstage#22002
• 🚀 Feature: Create a logo wall backstage/backstage#22003

in-toto

in-toto Analysis

• https://github.com/in-toto/docs/issues/85
• Create Doc Home Page in-toto/in-toto.io#34
• Create Getting Started Guide in-toto/in-toto.io#35
• Create a System Overview for user docs in-toto/in-toto.io#36
• Create a Glossary page in-toto/in-toto.io#37
• Develop a reference doc contribution policy in-toto/community#28
• Establish workflow for Python Reference Doc edits in-toto/in-toto#755
• Develop a user doc contribution policy in-toto/community#30

etcd

etcd Analysis
Contributing to etcd

• Umbrella Issue: CNCF Tech Doc Recommendations etcd-io/website#766
• Convert tutorials to tasks etcd-io/website#765
• Write Linux installation instructions etcd-io/website#767
• Consolidate all reference information etcd-io/website#768
• Make the Developer Guide task-oriented etcd-io/website#769
• Revise the installation guide etcd-io/website#770
• Create a System Overview etcd-io/website#771
• Relocate Benchmarks etcd-io/website#772
• Update the Upgrading landing page etcd-io/website#773
• Describe etcd's user roles etcd-io/website#780
• Write installation instructions for Kubernetes etcd-io/website#781
• Update quickstart and new user workflows etcd-io/website#782
• Make the Operations guide task-oriented etcd-io/website#783
• Reorganize the documentation etcd-io/website#784
• Revise the FAQ etcd-io/website#786

KEDA

KEDA Analysis
Contributing to KEDA

• Umbrella Issue: CNCF Tech Doc Recommendations kedacore/keda-docs#1361
• Reorganize the Documentation Table of Contents kedacore/keda-docs#1362
• Reorganize Concepts kedacore/keda-docs#1363
• Write a Getting Started guide kedacore/keda-docs#1364
• Update the Operator Guide kedacore/keda-docs#1365
• Create a Reference Topic kedacore/keda-docs#1366
• Write a Glossary kedacore/keda-docs#1367
• Write a Procedure for Setting Up a Scaler kedacore/keda-docs#1368
• Make user roles explicit kedacore/keda-docs#1369
• Separate reference and task information kedacore/keda-docs#1370
• Update the doc content creation instructions kedacore/keda-docs#1371
• Clarify the KEDA website and documentation maintainers kedacore/keda-docs#1372
• Remove non-inclusive language kedacore/keda-docs#1373

related

• KEDA HTTP Addon documentation kedacore/keda-docs#548
• Provide CI check to verify links kedacore/keda-docs#667
• Redesign how we present troubleshooting information kedacore/keda-docs#1270

The Update Framework (TUF)

TUF Analysis

LitmusChaos

Contributing to LitmusChaos

• CNCF Tech Doc Recommendations: Umbrella Issue litmuschaos/litmus-docs#294
• Single-source documentation litmuschaos/litmus-docs#295
• Remove obsolete websites litmuschaos/litmus-docs#296
• Mark a clear "getting started" path litmuschaos/litmus-docs#297
• Remove duplicate install instructions litmuschaos/litmus-docs#298

[MANISH-K-07]

@nate-double-u , I see the help wanted label here. I have attached a short overview of my intro at #162 (comment)
Can I help with the assessments?

[nate-double-u]

I believe any of these projects would welcome help @MANISH-K-07. I'd suggest heading over to one of the projects you're interested in and checking out their contributing processes!

[MANISH-K-07]

Sure, will go through the projects and find an issue that spikes my interest :)