Small edits (#1014)

2025-01-30 22:18:02 +00:00 · 2025-01-26 13:03:40 +02:00 · 2025-01-26 13:03:40 +02:00 · 535c9cc0bf
commit 535c9cc0bf
parent 86f5043d36
14 changed files with 19 additions and 18 deletions
--- a/docs/release_notes/clearml_agent/ver_0_16.md
+++ b/docs/release_notes/clearml_agent/ver_0_16.md
@ -6,7 +6,7 @@ title: Version 0.16
 :::


-### Trains-Agent 0.16.2
+### Trains Agent 0.16.2

 **Features**

--- a/docs/release_notes/clearml_agent/ver_0_17.md
+++ b/docs/release_notes/clearml_agent/ver_0_17.md
@ -2,7 +2,7 @@
 title: Version 0.17
 ---

-## ClearML Agent 0.17.2
+### ClearML Agent 0.17.2

 **Features**

--- a/docs/release_notes/clearml_agent/ver_1_1.md
+++ b/docs/release_notes/clearml_agent/ver_1_1.md
@ -4,7 +4,7 @@ title: Version 1.1

 ### ClearML Agent 1.1.2

-**Bug Fixes**
+**Bug Fix**

 - Fix the `six` conflict with the new `pathlib2` version 2.3.7 and up.

--- a/docs/release_notes/clearml_agent/ver_1_9.md
+++ b/docs/release_notes/clearml_agent/ver_1_9.md
@ -32,7 +32,7 @@ those matching these filters to be used when running containers

 ### ClearML Agent 1.9.1

-**New Features and Improvements**
+**New Feature**
 * Add default pip version support for Python 3.12

 ### ClearML Agent 1.9.0
--- a/docs/release_notes/clearml_server/enterprise/ver_3_20.md
+++ b/docs/release_notes/clearml_server/enterprise/ver_3_20.md
@ -23,7 +23,7 @@ title: Version 3.20

 ### Enterprise Server 3.20.1

-**New Features and Improvements**
+**New Feature**
 * Add support for serving UI from a subpath

 **Bug Fixes**
--- a/docs/release_notes/sdk/open_source/ver_0_17.md
+++ b/docs/release_notes/sdk/open_source/ver_0_17.md
@ -2,7 +2,7 @@
 title: Version 0.17
 ---

-## ClearML 0.17.5
+### ClearML 0.17.5

 **Features**

@ -135,14 +135,14 @@ title: Version 0.17

 ### ClearML 0.17.2

-**Bug Fixes**
+**Bug Fix**

 * Fix broken `clearml-task` CLI.


 ### ClearML 0.17.1

-**Bug Fixes**
+**Bug Fix**

 * `clearml-task` CLI link fixed.

@ -156,7 +156,7 @@ title: Version 0.17
 * Add `clearml-task` CLI for creating (importing) code into **ClearML** (see <a href="https://github.com/allegroai/clearml/blob/master/docs/clearml-task.md">details</a>).
 * Add `Task.create`, which supports importing a code / repository into **ClearML**, including remote execution with `clearml-agent`.

-**Bug Fixes**
+**Bug Fix**

 * PyJWT v2.0 breaks the interface.

--- a/docs/release_notes/sdk/open_source/ver_1_0.md
+++ b/docs/release_notes/sdk/open_source/ver_1_0.md
@ -95,13 +95,13 @@ title: Version 1.0

 ### ClearML 1.0.2

-**Bug Fixes**
+**Bug Fix**

 - Fix in rare scenarios process stuck on exit, again :)

 ### ClearML 1.0.1

-**Bug Fixes**
+**Bug Fix**

 - Fix in rare scenarios process stuck on exit

--- a/docs/release_notes/sdk/open_source/ver_1_12.md
+++ b/docs/release_notes/sdk/open_source/ver_1_12.md
@ -20,7 +20,7 @@ the Pipeline DAG at runtime (as opposed to adhering to the existing structure st
 * Raise error if dataset name is empty ([ClearML GitHub PR #1083](https://github.com/allegroai/clearml/pull/1083))
 * Add support for `spawn` start method for Python `multiprocess`. This should help circumvent issues like [this](https://github.com/python/cpython/issues/84559).

-**Bug Fixes**
+**Bug Fix**
 * Fix S3 uploads fail with `LazyEvalWrapper` type error ([ClearML GitHub issue #1081](https://github.com/allegroai/clearml/issues/1081))

 ### ClearML 1.12.0 
--- a/docs/release_notes/sdk/open_source/ver_1_14.md
+++ b/docs/release_notes/sdk/open_source/ver_1_14.md
@ -41,7 +41,7 @@ title: Version 1.14

 ### ClearML 1.14.1

-**Bug Fixes**
+**Bug Fix**
 * Fix created pipelines do not appear in the UI pipelines section

 ### ClearML 1.14.0
--- a/docs/release_notes/sdk/open_source/ver_1_2.md
+++ b/docs/release_notes/sdk/open_source/ver_1_2.md
@ -4,7 +4,7 @@ title: Version 1.2

 ### ClearML 1.2.1

-**Bug Fixes**
+**Bug Fix**

 - Fix HTTP download fails constructing URL ([ClearML GitHub issue #593](https://github.com/allegroai/clearml/issues/593))

--- a/docs/release_notes/sdk/open_source/ver_1_4.md
+++ b/docs/release_notes/sdk/open_source/ver_1_4.md
@ -4,7 +4,7 @@ title: Version 1.4

 ### ClearML 1.4.1 

-**Bug Fixes**
+**Bug Fix**
 * Fix Process Pool hangs at exit ([ClearML GitHub issue #674](https://github.com/allegroai/clearml/issues/674))

 ### ClearML 1.4.0
--- a/docs/release_notes/sdk/open_source/ver_1_7.md
+++ b/docs/release_notes/sdk/open_source/ver_1_7.md
@ -27,7 +27,7 @@ title: Version 1.7

 ### ClearML 1.7.1

-**New Features and Improvements**
+**New Feature**
 * Add callback option for pipeline step retry

 **Bug Fixes**
--- a/docs/webapp/settings/webapp_settings_users.md
+++ b/docs/webapp/settings/webapp_settings_users.md
@ -169,7 +169,7 @@ The user group table lists all the active user groups. Each row includes a group
 1. Click **+ ADD GROUP**
 1. In the dialog, add a group name and description
 1. Add members to the group. When clicking the input box, a list of workspace members appears, from which group members 
-   can be selected. Filter the list by typing part of the username. To remove a member, Hover over a user's row and click 
+   can be selected. Filter the list by typing part of the username. To remove a member, hover over a user's row and click 
   the <img src="/docs/latest/icons/ico-trash.svg" alt="Trash can" className="icon size-md" /> button
 1. Click **SAVE**

--- a/docs/webapp/webapp_project_overview.md
+++ b/docs/webapp/webapp_project_overview.md
@ -47,7 +47,8 @@ value. Click the point to go to the experiment's details page.

 ## Project Description

-Every project has a `description` field. The UI provides a Markdown editor to edit this field.
+Every project has a `description` field. The UI provides a Markdown editor to edit this field. For a quick reference for 
+the MarkDown syntax that can be used, see [Markdown Formatting Quick Guide](webapp_reports.md#markdown-formatting-quick-guide).

 In the Markdown document, you can write and share reports and add links to ClearML experiments 
 or any network resource such as issue tracker, web repository, etc.