Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS-1209][DOCS-1204] Document full-screen panel view, various panel sharing options, customizing number of panels per section #1087

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/images/app_ui/panel_fullscreen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 59 additions & 11 deletions content/guides/models/app/features/panels/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,58 @@ To add a custom panel to your workspace:

To learn more about the options for each type of panel, refer to the relevant section below, such as [Line plots]({{< relref "line-plot/" >}}) or [Bar plots]({{< relref "bar-plot.md" >}}).

## Share panels

This section describes the various ways to share a panel and how each way differs.

The settings of a project determine who can view the panel. This means that if the project is private, only members of the project can view the panel. If the project is public, anyone with the link can view the panel.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This true but also in practice not very relevant since practically all customer projects are private. Could we leave this for lower down?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it was really needed for explaining why you might not see the social links. Let me move / rework it.


### View and share a panel in full-screen mode
Copy link
Contributor

@tristan-spaulding2 tristan-spaulding2 Feb 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like this to be the primary action we guide people toward and I worry three things here are impeding that.

First, we're conflating the full-screen with the direct-link-to-panel points. Yes it's great that it's full screen, but the main improvement is that you are linking someone straight to the panel, rather than (as in the section titled "### Share a panel with a direct link") creating this pretty useless one-off Report that you then share. I think the section should first be clear on the link sharing part. The 10000 bins thing is a detail that fits better in the docs of the full screen panel mode itself than it does here in the sharing section.

Second, I think this section should come first, before "Share a panel with a direct link", which is the action we are basically obsoleting with this feature.

Third, I think we should rename the section currently called "Share a panel with a direct link", to something like what's in the product ("Share panel in report") so that it's not as easily confused with the new feature. In this action, you actually are not sharing the panel with a direct link, you are secretly creating a report, and sharing the link to that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, PTAL!

In full-screen mode, the panel plots 10,000 buckets rather than 1,000 when not in full-screen mode. The state of the run selector is preserved, so you can toggle runs on or off or search for runs.

1. Hover over the panel, then click the panel's action menu `...`.
1. Click the full-screen button, which looks like a viewfinder.
{{< img src="/images/app_ui/panel_fullscreen.png" alt="View panel full-screen" >}}

The panel opens in full-screen mode.
1. Copy the URL from the browser or click the action menu `...` and select **Copy panel URL**.
1. Share the link with the user or team. When they access the link, the panel opens in full-screen mode automatically.

The proceeding section shows how to determine a panel's full-screen URL programmatically.

#### Compose a panel's full-screen URL programmatically
In certain situations, such as when [creating an automation]({{< relref "/guides/models/automations/" >}}), it can be useful to include the panel's full-screen URL. This section shows how to compose The URL for a panel programmatically. In the proceeding example, replace the entity, project, panel, and section names in brackets.

```text
https://wandb.ai/<ENTITY_NAME>/<PROJECT_NAME>?panelDisplayName=<PANEL_NAME>&panelSectionName=<SECTON_NAME>
```

If multiple panels in the same section have the same name, this URL opens the first panel with the name.

### Share a panel with a direct link that anyone can access
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this and the following section are basically the same thing, the difference is whether it's a public link or not. Maybe they could be consolidated?

1. Hover over the panel, then click the panel's action menu `...`.
1. Click **Share panel in report**.
1. At the bottom of the **Invite** tab, optionally change **Only those who are invited have access** to **Anyone with the link can view**, then click **Copy report link**.
1. Share the link with the user or team.

### Share a panel as a report
1. Hover over the panel, then click the panel's action menu `...`.
1. Click **Share panel in report**.
1. In the **Invite** tab, enter an email address or username.
1. Specify **can view** or **can edit**.
1. Click **Invite**. W&B sends an email to the user with a clickable link to the report.

### Share or embed a panel publicly
To share a panel _publicly_, such as on social media or embedded in a website:
1. Hover over the panel, then click the panel's action menu `...`.
1. Click **Share panel in report**.
1. In the **Share** tab, change **Only those who are invited have access** to **Anyone with the link cah view**, then choose **Share on Twitter**, **Share on Reddit**, **Share on LinkedIn**, or **Copy embed link**.

### Determine a panel's full-screen URL programmatically
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think is hanging...you covered in a subsection above I think.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I'm misunderstanding. I think it is useful information we should documented, I just thought it was documented in the section "Compose a panel's full-screen URL programmatically" above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I think I finally understood, and have tried to address this in the latest commit.






## Manage panels

Expand All @@ -83,17 +135,6 @@ To move a panel to a different section, you can use the drag handle on the panel

You can also use the drag handle to rearrange panels within a section.

### Share a full-screen panel directly
Direct colleagues to a specific panel in your project. The link redirects users to a full screen view of that panel when they click that link. To create a link to a panel:

1. Hover your mouse over the panel.
2. Select the action `...` menu.
3. Click **Copy panel URL**.

The settings of the project determine who can view the panel. This means that if the project is private, only members of the project can view the panel. If the project is public, anyone with the link can view the panel.

If multiple panels have the same name, W&B shares the first panel with the name.

### Duplicate a panel

To duplicate a panel:
Expand Down Expand Up @@ -125,6 +166,13 @@ To add a section, click **Add section** after the last section.

To add a new section before or after an existing section, you can instead click the section's action `...` menu, then click **New section below** or **New section above**.


### Manage a section's visible panels
By default, each section shows 6 panels, but you can show a maximum of 100 panels. To customize a section that has more than 6 panels:

1. At the top of the section, click **1 to 6 of <X>**, where `<X>` is the total number of panels.
1. Choose how many panels to show.

### Rename a section

To rename a section, click its action `...` menu, then click **Rename section**.
Expand Down
Loading