Ceph : Issueshttps://tracker.ceph.com/https://tracker.ceph.com/favicon.ico2020-09-01T10:27:31ZCeph
Redmine Dashboard - Tasks #47230 (Resolved): mgr/dashboard: Move HACKING.rst into the main documentationhttps://tracker.ceph.com/issues/472302020-09-01T10:27:31ZLenz Grimmer
<p>The file <code>src/pybind/mgr/dashboard/HACKING.rst</code> in the git repository contains instructions on how to set up a Dashboard development environment and how to get started with development.</p>
<p>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).</p>
<p>Since it's already written in reStructuredText markup language, the transition should be fairly straightforward. The content of the actual <code>HACKING.rst</code> 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 <code>README.rst</code> file in the dashboard source directory.</p> Dashboard - Tasks #40767 (Resolved): mgr/dashboard: Document all REST API endpointshttps://tracker.ceph.com/issues/407672019-07-12T16:31:32ZLenz Grimmer
<p>Issue <a class="issue tracker-2 status-3 priority-4 priority-default closed child" title="Feature: mgr/dashboard: Automatic generation of REST API documentation based on Python docstrings (Resolved)" href="https://tracker.ceph.com/issues/24763">#24763</a> added the necessary groundwork that made it possible to auto-generate documentation of all REST API endpoints using Swagger. What's missing is the actual documentation of the existing REST API.</p> Dashboard - Tasks #40748 (Rejected): mgr/dashboard: Automate merging pull requests using Mergifyhttps://tracker.ceph.com/issues/407482019-07-12T09:08:02ZLenz Grimmer
<p>This was brought up during today's stand-up: the process of merging pending github pull requests should be fully automated. This removes the bottleneck of having an individual performing this task manually.</p>
<p>There is a third-party service called <a href="https://mergify.io/#how-it-works" class="external">Mergify</a> that could be utilized for this.</p>
<p>We should evaluate the functionality and define a workflow that would make sense for the majority of Dashboard PRs to pass through this workflow without manual interaction.</p>
<p>Some things to consider: how to deal with tests that fail quite frequently, e.g. <code>make check</code> on ARM64? How about QA tests that are triggered and checked manually? What are the risks of automating the final step of merging a PR?</p>
<p><img src="https://tracker.ceph.com/attachments/download/4269/Automate_1allthethings.png" alt="" /></p> Dashboard - Documentation #36243 (Resolved): mgr/dashboard: code documentationhttps://tracker.ceph.com/issues/362432018-09-27T16:27:16ZErnesto Puerta
<a name="Intro"></a>
<h3 >Intro<a href="#Intro" class="wiki-anchor">¶</a></h3>
This is review of a bunch of tools suitable for documenting the code. This is aimed at complementing the existing doc sources:
<ul>
<li>Ceph docs (doc/mgr/dashboard.rst): user focus</li>
<li>README: user focus</li>
<li>HACKING.rst: dev focus (introductory)</li>
<li>Swagger API docs: dev focus (as long as API is not meant to be consumed externally).</li>
</ul>
Some missing doc areas would be:
<ul>
<li>Architecture docs</li>
<li>Implementation docs</li>
</ul>
Both things may be covered with doc generators (Doxygen, Sphinx, etc). Due to the diversity of languages we may find:
<ul>
<li><b>General purpose doc generators</b>
<ul>
<li> <a href="http://www.sphinx-doc.org/en/master/" class="external"><b>Sphinx</b></a> is extensively used in Ceph docs. There are different plugins for JS support, most based on <a href="http://usejsdoc.org/" class="external">JSDoc</a>: <a href="https://pypi.org/project/sphinx-js/" class="external">sphinx-js</a>.</li>
</ul>
</li>
<li><b>Language-specific generatos</b>:
<ul>
<li> <a href="https://compodoc.app/guides/getting-started.html" class="external"><b>Compodoc</b></a> is an Angular focused tool for auto-doc'ing, also parsing JSDoc tags. [<a href="https://medium.com/learnwithrahul/automated-documentation-for-your-typescript-angular-projects-35746aa0ad5e" class="external">Screenshots</a>] [<a href="https://compodoc.github.io/compodoc-demo-todomvc-angular/" class="external">Online demo</a>]</li>
<li> <a href="http://typedoc.org/api/" class="external"><b>TypeDoc</b></a>: Typescript specific.</li>
</ul></li>
</ul> Dashboard - Documentation #24210 (New): mgr/dashboard: Implement and document UX design workflow ...https://tracker.ceph.com/issues/242102018-05-21T10:51:03ZKanika Murarka
<p>Currently we don't have a process for designing and deciding mockups and designs for Dashboard.<br />A process of mockup creation is required to evaluate deign before it should be coded.</p>