docs icon indicating copy to clipboard operation
docs copied to clipboard

Consider having a developer-specific page (or pages) in the docs

Open lkatalin opened this issue 2 years ago • 3 comments

Description It is important to have good documentation for developers, but not everyone will need to know those details meant for developers only. Should we start a development-specific page or pages within the Sigstore documentation? And what could this look like? Some options:

  1. Have a developer-specific page under each project, ex. Rekor -> development, Cosign -> development (on an as-needed basis)
  2. Have a developer-specific top section, and add pages under that section for each project (as needed)
  3. Keep developer-specific info in the project repos (in README.md files)

Something else?

Personally I think 1 or 3 would make the most sense, because people are likely to look for dev-specific details under each project (rather than at top level), and also because the dev-specific documentation will differ for each project.

Reference issue: https://github.com/sigstore/docs/pull/110

lkatalin avatar Apr 07 '23 17:04 lkatalin

I like the #1 approach. Alternately, we can have the docs in the repos as #3 and then set up automation to pull those files into the frontend site and keep them maintained. That would require more upfront work but less maintenance burden.

ltagliaferri avatar Apr 07 '23 18:04 ltagliaferri

1 sounds like a good approach

Hayden-IO avatar Apr 08 '23 20:04 Hayden-IO

Yep, I also like the #1 approach.

Neilblaze avatar Apr 09 '23 20:04 Neilblaze