Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • If it describes steps for how to build up to a specific, tangible example that can be run, it is a tutorial.
  • If it describes a work-in-progress or a to-be-implemented function related to ONOS itself, it is a feature proposal.
  • If it describes a mature function or feature and focuses on:
    • Describing the The design, architecture, and/or implementation, it is part of the Architecture Guide.
    • How to extend or modify functionality through code (APIs, classes/interfaces, etc), it is part of the Developer's Guide.
    • How a user can interact with it, it is part of the User's Guide.
  • If it describes anything about a use case, it should be added under Use Cases. For existing use cases, it is best to consult its members for where the page/topic belongs.

Asking questions

Join us on the onos-docs channel on Slack, or send a message to the onos-discuss mailing list if you have any questions about how to contribute to documentation.

...