Bug #40523: mgr/dashboard: HACKING.rst stopped being rendered by Github - Dashboard - Ceph

Actions

Copy link

Bug #40523

closed

mgr/dashboard: HACKING.rst stopped being rendered by Github

Added by Ernesto Puerta almost 5 years ago. Updated about 3 years ago.

Status:

Resolved

Priority:

Low

Assignee:

Tatjana Dehler

Category:

General

Target version:

% Done:

Source:

Tags:

Backport:

Regression:

Severity:

5 - suggestion

Reviewed:

Affected Versions:

ceph-qa-suite:

Pull request ID:

28841

Crash signature (v1):

Crash signature (v2):

Description

After commit https://github.com/ceph/ceph/commit/0c64f40607f156ee7bdd3f76465ff92044af7398#diff-5e9d3f8568cca246ab3e6995b7b9eeeb, Github no longer renders HACKING.rst (https://github.com/ceph/ceph/blob/0c64f40607f156ee7bdd3f76465ff92044af7398/src/pybind/mgr/dashboard/HACKING.rst), and instead shows the code of the doc file. In the previous commit it's properly rendered (https://github.com/ceph/ceph/blob/754e08017714543d71835c0deb3853603567f2b4/src/pybind/mgr/dashboard/HACKING.rst).

reStructuredText/Sphinx validator (https://livesphinx.herokuapp.com/) does not report any issue, and the modified text does not seem to bring any issues, so perhaps Github imposes some length limitation to .rst file rendering.

If that's the case and we still want to show it rendered, we may split HACKING in several sub-sections.

I'd consider this just a cosmetic issue, but as I was going to point someone in dev@ceph.io to this guide, it might be worthy to fix it. Sugestions on how to break it down (front-end, back-end)?