Project

General

Profile

Actions
Copy link

Tasks #47230

closed

mgr/dashboard: Move HACKING.rst into the main documentation

Added by Lenz Grimmer over 3 years ago. Updated about 3 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Zac Dover
Category:
Docs
Target version:
Ceph - v16.0.0
% Done:

0%

Tags:
Reviewed:
Affected Versions:
Pull request ID:
37070

Description

The file src/pybind/mgr/dashboard/HACKING.rst in the git repository contains instructions on how to set up a Dashboard development environment and how to get started with development.

It has grown significantly in size of scope and has become an invaluable resource for new joiners. However, it's current location deeply nested in the git repository makes it hard to find and it's not searchable. To give this document more exposure, the content should be moved into the Ceph Documentation (which contains other developer-oriented documentation already).

Since it's already written in reStructuredText markup language, the transition should be fairly straightforward. The content of the actual HACKING.rst file should then be replaced with a pointer to the documentation. Any other references to the file should also be updated accordingly, e.g. the README.rst file in the dashboard source directory.

Files

Download all files
sphinx-err-npo22ybr.log (13.2 KB) sphinx-err-npo22ybr.log Zac Dover, 09/08/2020 09:04 AM
sphinx-err-qc6ee89i.log (13 KB) sphinx-err-qc6ee89i.log Zac Dover, 09/08/2020 01:33 PM

Related issues 2 (1 open — 1 closed)

Related to Dashboard - Bug #47396: mgr/dashboard: Remove HACKING.rst now that the content was added to the docsResolvedLenz Grimmer

Actions
Related to Dashboard - Bug #47458: mgr/dashboard: replace URLs with doc references in dash-devel.rst Triaged

Actions
Actions
Copy link

Also available in: Atom PDF