Tasks #47230
Updated by Lenz Grimmer over 3 years ago
The file @src/pybind/mgr/dashboard/HACKING.rst@ @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.