ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-02-07 13:21:46 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Clarify report description searchability (#469)

Browse Source
This commit is contained in:
pollfly 2023-02-07 10:17:50 +02:00 committed by GitHub
parent 81bf15e39c
commit f77403e6d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/webapp/webapp_reports.md
View File

@ -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.