Skip to content

Commit

Permalink
Pbench Dashboard Doc (#3431)
Browse files Browse the repository at this point in the history
* PBENCH-1158
Pbench Dashboard Doc
User guide for Pbench Dashboard
  • Loading branch information
MVarshini authored Jun 5, 2023
1 parent fd290c4 commit 22ade07
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 1 deletion.
Binary file added docs/Dashboard/assets/images/BrowsingPage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Dashboard/assets/images/Overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Dashboard/assets/images/UserProfile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 27 additions & 1 deletion docs/Dashboard/user_guide.md
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
# Pbench Dashboard User Guide
# Pbench Dashboard

Pbench Dashboard is the web-based platform for consuming indexed performance benchmark data. It provides data curation capabilities for the performance datasets.

The landing page is the browsing page where the user can view the list of public datasets. Those datasets can be filtered based on name and/or uploaded time.

![Browsing Page](assets/images/BrowsingPage.png)

Login button can be found on the right side of the Header. Clicking on it will redirect the browser to the login page.

On logging in, the user can view the Overview Page which is the data curation page.
It has three components.

- *New and Unmanaged Runs* shows the newly created runs which can be saved
- *Saved Runs* lists the saved runs which can be published to share with others
- *Expiring Runs* lists the saved runs which will be deleted from the server within the next 20 days


![Overview](assets/images/Overview.png)


The *User Profile* page can be used to view profile information from the OIDC authentication as well as to view and manage Pbench Server API keys. This page is accessed by selecting the *My profile* option from the dropdown menu activated by clicking on the username at the right end of the header bar.

From this page, Pbench Server API keys can be created by clicking on the *New API Key* button; existing keys are listed with their labels and creation dates; and, the keys can be copied or deleted using the icon buttons.

![User Profile](assets/images/UserProfile.png)

0 comments on commit 22ade07

Please sign in to comment.