operator-controller icon indicating copy to clipboard operation
operator-controller copied to clipboard

Docs: Write a docs brief for the next phase of our documentation

Open michaelryanpeter opened this issue 11 months ago • 0 comments

User story

Write a brief covering the next phase of the OLM v1 documentation

Immediate concerns

  • should we document endpoints that are not part of our public API?
  • coming up with a style guide
  • linting for style guide issues
  • brief > rfc > doc/drafts > published workflow

Long term concerns

  • what to do with FBC/catalog docs
  • what to do with legacy OLM and SDK docs
  • what to do with operatorframework.io
  • netlify vs. GitHub builds for docs

List if issues

n/a

New content or update?

Net-new content

Types of documentation

No response

References

No response

michaelryanpeter avatar Dec 23 '24 22:12 michaelryanpeter