Update docs (#948)

This commit is contained in:
pollfly
2024-11-03 15:32:30 +02:00
committed by GitHub
parent af5639ac99
commit be102be4c3
51 changed files with 458 additions and 48 deletions

View File

@@ -21,12 +21,23 @@ page when relevant).
Project folders display summarized project information:
<div class="max-w-50">
![Project card](../img/webapp_project_card.png)
When relevant, the folder has a tab which displays the number of subprojects in the project. Click the tab to view a list of
subprojects. Click on a subproject's name to navigate to it.
</div>
![Subproject tab](../img/webapp_sub_project_card.png)
* When the project contains subprojects, the folder shows the number of subprojects within the project as an additional
tab. Click the tab to view a list of subprojects, and click on a subproject's name to navigate to it.
<div class="max-w-50">
![Subproject tab](../img/webapp_sub_project_card.png)
</div>
* When a project's `default_output_destination` is set, the folder displays the <img src="/docs/latest/icons/ico-info.svg" alt="Info" className="icon size-md space-sm" />
indicator. Hover over the indicator to view the default output destination.
<Collapsible title="Hidden Projects" type="configuration">
@@ -47,7 +58,7 @@ of a project folder to open its context menu and access the following project ac
![Project context menu](../img/webapp_projects_context_menu.png)
* **Rename** - Rename the project.
* **Edit** - Rename the project and/or modify its default output destination.
* **New Project** - Create a new project (by default a subproject).
* **Move to** - Move the project into another project. If the target project does not exist, it is created on-the-fly.
* **Delete** - Delete the project. To delete a project, all of its contents (i.e. any pipelines/reports/datasets) must
@@ -64,4 +75,11 @@ action. For more information see [Custom UI Context Menu Actions](../deploying_c
To create a project, click the **+ NEW PROJECT** button in the top right of the page or in a project's context menu,
which will open a **New Project** modal.
![New project modal](../img/webapp_projects_new_project.png)
![New project modal](../img/webapp_projects_new_project.png)
* Project name
* Create in - Where the project should be created, either as a top-level project (create in `Projects root`) or as a
subproject of another project
* Description
* Default output destination - The storage location where model checkpoints (snapshots) and artifacts will be uploaded
when tasks in this project that do not have an explicit output destination specified are executed