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.

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

Docs map #10

Open
lungdear opened this issue Mar 19, 2024 · 0 comments
Open

Docs map #10

lungdear opened this issue Mar 19, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@lungdear
Copy link

Need a complete map of which documentation is where, who it's for, and how fresh/stale a given piece of documentation is

  1. High level document map:
  • Architecture (Engineer/Architects): what are the pieces, how do the fit together, and how do they communicate
  • Deployment (Operators): how do I get it up and running
  • Use Guide (End Users): how do I configure and run it
  • Developer Guide (Developers): how do I setup a dev environment, write tests, push code back
  • Datasheet / Whitepaper(s) (Business): how does it compare to other SDN options
  • Quick Start Guide (Developers, Operators, and End Users): 15 minutes to fame
  1. Map the above to existing documents
  • Randy to get feedback from the group on the freshness of the existing documents
  • Documentation/Tech Writer resources?
  • Yury suggests slow and steady re-write a document at a time
  • Randy: If we have the document map this might be doable
@randybias randybias added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 9, 2024
@randybias randybias added this to the rel1 milestone Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: No status
Development

No branches or pull requests

2 participants