cncf/techdocs

CNCFSD-1791 Support request to improve the technical documentation on the Backstage Project

Closed this issue · 8 comments

I've completed a first draft of the Backstage Docs Assessment. Still TBD:

  • Review and revision. Please review and comment ASAP.
  • Need help completing the Website assessment: analytics, indexing, search, maintenance, accessibility, mobile.
  • Complete recommendations for analysis into actionable issues. For this, will need to collaborate with @nate-double-u and other CNCF and Backstage stakeholders to create a backlog.

Awesome, thanks @dwelsch-esi, could you open a PR to the assessments folder, and share that PR in the CNCF slack #backstage-docs channel?

The PR is where we should collect feedback at this point.

Pull request for Backstage doc assessment:
#189

Updated the Backstage doc assessment, including website comments and recommendations per @thisisobate:
https://github.com/cncf/techdocs/pull/189/commits

reopening as a potential umbrella issue for the next phase: opening issues to track the work laid out in the analysis

Closing this as complete.

You can find the report here: https://github.com/cncf/techdocs/tree/main/assessments/0008-backstage, as well as an umbrella issue laying out our recommendations here: backstage/backstage#21893