From f77403e6d65f47a6b3a85b9f13d49086045c0657 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Tue, 7 Feb 2023 10:17:50 +0200 Subject: [PATCH] Clarify report description searchability (#469) --- docs/webapp/webapp_reports.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/webapp/webapp_reports.md b/docs/webapp/webapp_reports.md index ef766387..66d8aa1f 100644 --- a/docs/webapp/webapp_reports.md +++ b/docs/webapp/webapp_reports.md @@ -18,7 +18,8 @@ With ClearML’s Reports you can write up notes, experiment findings, or really in any of your ClearML projects. In addition to its main document, a report also contains a description field, which will appear in the report's card in -the [Reports Page](#reports-page). +the [Reports Page](#reports-page). Reports are searchable based on their description, so adding a description +can make it easier to find the report later. Reports are editable Markdown documents, supporting: * Multi-level headings @@ -97,7 +98,7 @@ of a report card to open its context menu and access report actions: * **Rename** - Change the report’s name * **Share** - Copy URL to share report -* **Add Tag** - Add label to the report to help easily classify groups of reports. +* **Add Tag** - Add labels to the report to help easily classify groups of reports. * **Move to** - Move the report into another project. If the target project does not exist, it is created on-the-fly. * **Archive** - Move report from active reports page to archive * **Delete** - Delete the report. To delete a report, it must first be archived.