Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Curate / simplify the README to make it more user-friendly #6

Closed
antoninbas opened this issue Nov 4, 2019 · 3 comments
Closed

Curate / simplify the README to make it more user-friendly #6

antoninbas opened this issue Nov 4, 2019 · 3 comments
Assignees
@salv-orlando
Labels
p0

Comments

@antoninbas
Copy link
Contributor

  • see the Contour README for a good example
  • add the "Overview" keyword for the first section and simply it, assume readers are already familiar with such things as "CNI" otherwise they would not have landed therew
  • "Features" section: unless something is very different from other CNI, just add a link in the README to that list of features. Or put it at the end of the README. Do not be redundant with ROADMAP.
@salv-orlando salv-orlando self-assigned this Nov 6, 2019
@andrewsykim andrewsykim added the p0 label Nov 7, 2019
@antoninbas antoninbas self-assigned this Nov 21, 2019
@antoninbas
Copy link
Contributor Author

@salv-orlando are we good to close this?

@salv-orlando
Copy link
Contributor

@abas as far as I'm concerned, yes.

@antoninbas
Copy link
Contributor Author

Fixed by #33

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@salv-orlando salv-orlando

Labels
p0
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@salv-orlando @antoninbas @andrewsykim