Skip to content

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

@michaelryanpeter

Description

@michaelryanpeter

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/documentationCategorizes issue or PR as related to documentation.lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions