[Docs] dashboard and ci docs (#1384)

* dashboard and ci docs --------- Signed-off-by: luarss <[email protected]> Signed-off-by: Vitor Bandeira <[email protected]> Co-authored-by: Vitor Bandeira <[email protected]>
The-OpenROAD-Project · Aug 25, 2023 · 7db5d2c · 7db5d2c
1 parent 845d65e
commit 7db5d2c
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 1 deletion.
diff --git a/docs/images/comparison.webp b/docs/images/comparison.webp
diff --git a/docs/images/trends.webp b/docs/images/trends.webp
diff --git a/docs/toc.yml b/docs/toc.yml
@@ -37,11 +37,18 @@ entries:
 - file: user/FAQS.md
   title: FAQs
 
-
 - file: tutorials/TutorialHome
   title: Tutorials
   entries:
   - file: tutorials/FlowTutorial
     title: Flow Tutorial
   - file: tutorials/Notebooks
     title: Running the OpenROAD Flow in Google Colab
+
+- file: user/Flow_QoR_CI.md
+  title: Flow QoR and CI Metrics
+  entries:
+  - file: user/QoRDashboard.md
+    title: Using the OpenROAD Dashboard to track and analyze QoR
+  - file: user/Jenkins.md
+    title: Exploring CI Metrics with Jenkins
diff --git a/docs/user/Flow_QoR_CI.md b/docs/user/Flow_QoR_CI.md
@@ -0,0 +1,12 @@
+# OpenROAD QoR and CI Metrics
+
+## OpenROAD Dashboard 
+
+The [OpenROAD Dashboard](QoRDashboard.md) provides an easy way to explore 
+Quality-of-Results (QoR) over time and describes flow-QoR metrics, such as timing, area, power, etc. 
+
+## Jenkins CI
+
+We use Jenkins as our continuous integration (CI) tool.
+You may use it to find out metrics regarding regression tests.
+See more about accessing and taking advantage of our CI [here](Jenkins.md).
diff --git a/docs/user/Jenkins.md b/docs/user/Jenkins.md
@@ -0,0 +1,10 @@
+# Jenkins Continuous Integration
+
+The Jenkins website is at [https://jenkins.openroad.tools/](https://jenkins.openroad.tools/). 
+For an in-depth tutorial on how to access the CI metrics, please see
+the [link](https://docs.google.com/presentation/d/1kWHLjUBFcd0stnDaPNi_pt9WFrrsR7tQ95BGhT1yOvw/)
+
+```{Note}
+This document is not static is constantly being updated due to changes 
+in the functionality of Jenkins.
+```
diff --git a/docs/user/QoRDashboard.md b/docs/user/QoRDashboard.md
@@ -0,0 +1,32 @@
+# Using the OpenROAD Dashboard to track and analyze Quality of Results
+
+The metrics dashboard [(https://dashboard.theopenroadproject.org/)](https://dashboard.theopenroadproject.org/)
+is tailored for RTL-to-GDS flow stages, targeting different designs across
+various platforms. The dashboard comprises two main pages: the trends
+page and the comparison page.
+
+## Trends
+
+The trends page allows users to visualize metric trends through 
+interactive graphs, enabling the selection of platforms, designs, 
+and metrics for each platform. This feature aids in tracking the 
+fluctuations of metrics over time.
+
+![Trends](../images/trends.webp)
+
+## Comparison 
+
+The comparison page lets users compare metrics between branches 
+or commits for a specific platform and its designs. The comparison is 
+shown as a table showcasing the differences between the 
+base source and the test source. This page also offers deeper insights, 
+like the platform summary table that presents statistical trends for 
+different designs within a platform and a summary table that 
+provides insights for the set of selected designs, with added 
+functionality for filtering.
+
+![Comparison](../images/comparison.webp)
+
+These pages combine to create a comprehensive dashboard facilitating 
+data-driven decision-making and performance optimization in the 
+design flow.