Skip to content

RFC: redesign this repo's README and documentation #214

@mattklein123

Description

@mattklein123

I don't think the README for this repo, as a landing page for understanding the TOC, is in the best interest of our community. A few high level notes of things I would like to discuss doing:

  • Leave overview, members, and mailing list / meeting / contact info
  • Move all other sections into sub-pages, linked to from the primary README
  • On the projects page, either remove it and link to the main CNCF site, or clearly break down between graduated, incubating, and sandbox.
  • On the main page, have a section on "proposing a new project for the CNCF," with a brief overview and then further links into the contributing guidelines. The goal here should be to make contributors and the community feel very comfortable with the process without having to click through various un-linked pages to try to piece things together.
  • On the main page, have a section on SIGs with a brief overview and links for further information, how to join, etc.

Is there anything else anyone would like to see?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions