Project

General

Profile

Documentation #36243

mgr/dashboard: code documentation

Added by Ernesto Puerta 11 months ago. Updated 4 months ago.

Status:
Pending Backport
Priority:
Normal
Category:
dashboard/general
Target version:
Start date:
09/27/2018
Due date:
% Done:

0%

Tags:
Backport:
nautilus
Reviewed:
Affected Versions:
Pull request ID:

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:

Related issues

Related to mgr - Bug #39556: mgr/dashboard: npm problem causes "make-dist" to fail when directory contains colon character Verified 05/01/2019
Copied to mgr - Backport #39345: nautilus: mgr/dashboard: code documentation In Progress

History

#1 Updated by Ernesto Puerta 11 months ago

  • File deleted (compodoc_overview)

#2 Updated by Ernesto Puerta 11 months ago

  • Description updated (diff)
  • Status changed from New to In Progress

#3 Updated by Ernesto Puerta 11 months ago

  • Description updated (diff)

#4 Updated by Ernesto Puerta 11 months ago

  • Description updated (diff)

#5 Updated by Ernesto Puerta 4 months ago

  • Status changed from In Progress to Need Review
  • Pull request ID set to 27433

#6 Updated by Ernesto Puerta 4 months ago

Ceph-Dashboard docs landing page as generated by compodoc:

#7 Updated by Lenz Grimmer 4 months ago

  • Tags set to development
  • Status changed from Need Review to Pending Backport
  • Target version set to v15.0.0
  • Backport set to nautilus

#8 Updated by Nathan Cutler 4 months ago

  • Copied to Backport #39345: nautilus: mgr/dashboard: code documentation added

#9 Updated by Nathan Cutler 4 months ago

  • Related to Bug #39556: mgr/dashboard: npm problem causes "make-dist" to fail when directory contains colon character added

Also available in: Atom PDF