First batch of new ui doc changes

This commit is contained in:
Mike Solomon
2025-02-21 10:06:31 -08:00
parent c60130568e
commit 1f45d3d5ae
20 changed files with 13 additions and 21 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 127 KiB

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 81 KiB

After

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 175 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 186 KiB

After

Width:  |  Height:  |  Size: 280 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 136 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 31 KiB

View File

@@ -39,9 +39,9 @@ When you're ready to run the recipe, press the `Dry Run` button at the top of yo
As the code in the SaaS is constantly changing, your results will more than likely be different.
:::
![](./assets/common-static-analysis-run.png)
![](./assets/recipe-results.png)
You can click on any of the repositories to look at the suggested changes and learn more about why the code is being changed. Some of these changes are rather complex, such as changing anonymous inner classes that contain only one method into lambdas:
By default, changes will be displayed on the right hand of your screen for the selected repository. You can click on any of the other repositories to look at their suggested changes and learn more about why the code is being changed. Some of these changes can be rather complex, such as changing anonymous inner classes that contain only one method into lambdas:
![](./assets/lambda-example.png)

View File

@@ -41,17 +41,17 @@ To get started, make sure you've selected the `Default` organization and then ru
You will then be taken to the recipe results page:
![](./assets/check-dep-4.png)
![](./assets/find-vuln-dep-results.png)
If the recipe can fix a security vulnerability, it will do so. You can view the diffs and commit the results as you would in any other recipe. In most situations, however, this recipe will identify that there is a security vulnerability rather than fix it. If there are security vulnerabilities identified, the recipe will produce a detailed data table.
To see the data table, wait until the recipe has finished running and then click on the `Data Tables` tab:
![](./assets/check-dep-2.png)
![](./assets/data-tables-tab.png)
You should now be on a page that lists all of the data tables available for this recipe:
![](./assets/check-dep-3.png)
![](./assets/data-tables-list.png)
As the `recipe performance` and `source files that had results` tables are primarily for the people who wrote the recipe, let's ignore them and focus on the `vulnerability report` data table instead (feel free to download them and look at them, though). The `vulnerability report` table was specifically coded into the `check for dependency vulnerabilities` recipe and it will have data relevant to our needs.

View File

@@ -83,21 +83,17 @@ Click _Dry Run_ to start the recipe. You might be asked for additional GitHub pe
<figcaption>Dry run selection</figcaption>
</figure>
On the results page, you will see a summary of your recipe criteria and an indication of progress.
On the results page, you will see a summary of your recipe criteria, an indication of progress, and some of the results that were found.
<figure>
![Example results](./assets/recipe-results.png)
<figcaption>Example results</figcaption>
</figure>
Each result shows the number of files searched and how many changes were detected.
import diff from './assets/diff-button.png';
To see the proposed changes, click on either the <img src={diff} /> button under `Actions` or the name of the repository (e.g. _openrewrite/rewrite_).
## Step 7: View the results
You can click on any repository to check out the changes.
The resulting diff allows you to preview the changes from the recipe before you decide what you want to do.
<figure>
@@ -107,13 +103,13 @@ The resulting diff allows you to preview the changes from the recipe before you
If you're unsure why something changed, you can click on the three dots (`...`) at the top right of any file and select `Why did this change?`
For instance, in the above example, the identifiers were reordered due to the [modifier order rule](https://app.moderne.io/recipes/org.openrewrite.staticanalysis.ModifierOrder).
For instance, in the above example, we modified initializations based on the [explicit initialization recipe](https://app.moderne.io/recipes/org.openrewrite.staticanalysis.ExplicitInitialization).
## Step 8: Commit your changes
Once you've confirmed you want to make the changes, the next course of action is to commit everything.
In the results view, select the repositories you want to commit and then click _Commit Selected_.
In the results view, select the repositories you want to commit and then click _Commit selected results_ in the bottom left.
<figure>
![Repositories selected to commit changes on](./assets/CommitSelected.png)

View File

@@ -56,16 +56,12 @@ If a recipe produces a visualization, you can find them in the `Visualizations`
![Visualizations button](./assets/visualizations-tab.png)
When you click on it, you'll be taken to a page that contains all of the visualizations available for that recipe. Some recipes may only have one visualization whereas others might have many:
![Visualizations list](./assets/visualizations-list.png)
Click on the one you want to execute. After you do, the visualization box will expand. Some visualizations will offer you options to choose from to tune the visualization to your needs:
![Visualization options](./assets/visualizations-options.png)
The visualizations page will often include multiple visualizations. Find the one you want to run and, if it has options to fill out, fill them in as needed.
Visualization options serve two main purposes: they can change the rendering of the visualization (such as turning a node from a square to a circle) or they can subset the data (e.g., taking 1000 nodes and filtering them down to 100 that match your specific needs).
![Visualizations list](./assets/visualizations-list.png)
Once you've selected the options you want, click the `Run Visualization` button at the bottom:
![Run visualization](./assets/run-visualization.png)