Documentation #36243
closed
mgr/dashboard: code documentation
Added by Ernesto Puerta over 5 years ago.
Updated about 3 years ago.
Description
Intro¶
This is review of a bunch of tools suitable for documenting the code. This is aimed at complementing the existing doc sources:
- Ceph docs (doc/mgr/dashboard.rst): user focus
- README: user focus
- HACKING.rst: dev focus (introductory)
- Swagger API docs: dev focus (as long as API is not meant to be consumed externally).
Some missing doc areas would be:
- Architecture docs
- Implementation docs
Both things may be covered with doc generators (Doxygen, Sphinx, etc). Due to the diversity of languages we may find:
- General purpose doc generators
- **Sphinx** is extensively used in Ceph docs. There are different plugins for JS support, most based on JSDoc: sphinx-js.
- Language-specific generatos:
- File deleted (
compodoc_overview)
- Description updated (diff)
- Status changed from New to In Progress
- Description updated (diff)
- Description updated (diff)
- Status changed from In Progress to Fix Under Review
- Pull request ID set to 27433
Ceph-Dashboard docs landing page as generated by compodoc:
- Translation missing: en.field_tag_list set to development
- Status changed from Fix Under Review to Pending Backport
- Target version set to v15.0.0
- Backport set to nautilus
- Copied to Backport #39345: nautilus: mgr/dashboard: code documentation added
- Related to Bug #39556: npm problem causes "make-dist" to fail when directory contains colon character added
- Status changed from Pending Backport to Resolved
backport was merged. resolve.
- Related to deleted (Bug #39556: npm problem causes "make-dist" to fail when directory contains colon character)
- Project changed from mgr to Dashboard
- Category changed from 132 to General
Also available in: Atom
PDF