8408ab0e63
Signed-off-by: Jim Ma <majinjing3@gmail.com> |
||
|---|---|---|
| .. | ||
| api-reference | ||
| cli-reference | ||
| config | ||
| development | ||
| ecosystem | ||
| images | ||
| user-guide | ||
| FAQ.md | ||
| README.md | ||
| ROADMAP.md | ||
README.md
Dragonfly Document
Dragonfly Document is written, drawn, memorialized representation of all things about Dragonfly. For those who are generally interested in Dragonfly, README.md of this repo is sufficient. While for end users, all details contained in /docs is the best guide all should have. And for developers, contents in Developer Guide part is that all need.
Organization of document is as following:
How to Contribute Document
Find WIP or TODO in this page and follow CONTRIBUTING.
Quick Start
Quick Started is exactly what you need if you would give Dragonfly a try. This document includes what are the prerequisites, how to install Dragonfly and how to experience Dragonfly's usage.
User Guide
User Guide helps all kinds of guidance end users need to experience Dragonfly. Not only the very brief [Quick Start] (user-guide/quick-start.md), but the detailed binary installation and configure illustration. In addition, any concept and function which help users understand Dragonfly better would be included as well.
CLI Reference
For almost all users, commandline is the first reference you may need. Document in directory CLI Reference is about command detailed usage of Dragonfly CLI including dfget, cdnsystem, scheduler and manager. You can get introductions, synopsis, examples, options about command. Last but not least, Dragonfly can guarantee commandline docs is strongly consistent with Dragonfly CLI's source code. What's more, all commandline docs are auto generated via source code.
[TODO] API Reference
Commandline is the easiest way to experience Dragonfly's ability. API extension will bring more further experience of Dragonfly. Commandline is just one kind of combination usage of API, if you wish to hack or take more advantages of Dragonfly, please see API Reference. Like command line document, all API docs are auto generated via source code.
Ecosystem
Ecosystem documents show connections between Dragonfly and popular tool or system in cloud native ecosystem. They guide end users how to experience cloud native systems with Dragonfly, such as other CNCF project Kubernetes and Harbor.
Developer Guide
Develop Guide helps (potential) developers/contributors to understand the theory inside Dragonfly rather than the interface it exposes. With better understanding of how Dragonfly is designed, developer could learn source code of Dragonfly much easier and know how to debug, test and hack.
[TODO] Design Doc
Design Doc is content all about design of Dragonfly. It includes all things taken into consideration at the very beginning, the architecture designed for all components in Dragonfly, the interactive workflow between components, all APIs in Dragonfly and some technical things else.
[TODO] Test Guide
Test Guide is the best reference helping contributors get aware of how to setup testing environment and do it. Currently we can divide test of Dragonfly into four dimensions:
- unit test;
- API integration test;
- CLI integration test;
- node e2e test.
For more details, please refer to test.
Conclusion
The folder /docs does not contain all the document about Dragonfly. There are still other really helpful documents in other path of this repo, like:
- TODO FAQ.md
- CHANGELOG.md
- TODO ROADMAP.md
- others.
If you are searching some document and find no one, please do not hesitate to file an ISSUE for help. In addition, if you found that there are some incorrect places or typos in document, please help submit a pull request to correct that.