diff --git a/README.md b/README.md index b437e8db..8c13a62f 100644 --- a/README.md +++ b/README.md @@ -9,4 +9,3 @@ Pretty awesome, right? Recipes transform code at the Abstract Syntax Tree \(AST\) level. While the resulting code may look different, the meaning of the code remains the same. {% embed url="https://youtu.be/uR9EPALJKjI" caption="" %} - diff --git a/SUMMARY.md b/SUMMARY.md index 835ffff8..46acd594 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,20 +1,19 @@ # Table of contents -* [Welcome to Moderne](README.md) +- [Welcome to Moderne](README.md) ## Getting Started -* [Quick Start: Running your first recipe](getting-started/running-your-first-recipe.md) +- [Quick Start: Running your first recipe](getting-started/running-your-first-recipe.md) ## How-to Guides -* [Creating your own recipes with Builder](how-to/creating-your-own-recipes-with-builder.md) -* [Importing projects from GitHub](how-to/importing-projects-from-github.md) -* [Importing External Recipes](how-to/importing-external-recipes.md) +- [Creating your own recipes with Builder](how-to/creating-your-own-recipes-with-builder.md) +- [Importing projects from GitHub](how-to/importing-projects-from-github.md) +- [Importing External Recipes](how-to/importing-external-recipes.md) ## References -* [Repository Selection](references/repository-selection.md) -* [GitHub Permissions](references/github-permissions.md) -* [Token Management](references/create-api-access-tokens.md) - +- [Repository Selection](references/repository-selection.md) +- [GitHub Permissions](references/github-permissions.md) +- [Token Management](references/create-api-access-tokens.md) diff --git a/getting-started/running-your-first-recipe.md b/getting-started/running-your-first-recipe.md index 4d8cfcdc..a61d8f05 100644 --- a/getting-started/running-your-first-recipe.md +++ b/getting-started/running-your-first-recipe.md @@ -4,11 +4,11 @@ To help orient you to Moderne, let's run a couple of recipes on some open source In this guide, we will -* [ ] **Login with GitHub** -* [ ] **Find a recipe to search across multiple repositories** -* [ ] **Examine the results of our recipe** -* [ ] **Narrow our focus and run a recipe to transform a repository based on the search** -* [ ] **Verify the results and issue a Pull Request to transform the code** +- [ ] **Login with GitHub** +- [ ] **Find a recipe to search across multiple repositories** +- [ ] **Examine the results of our recipe** +- [ ] **Narrow our focus and run a recipe to transform a repository based on the search** +- [ ] **Verify the results and issue a Pull Request to transform the code** ## Step 1: Go to [app.moderne.io](https://app.moderne.io) and _Login_ @@ -44,9 +44,9 @@ Let's find a good recipe to start from to help illustrate how to search across m To narrow our scope a little bit, from the Recipe details page for _SpringBoot 2.x Best Practices:_ -* Click the _Select Repositories_ button -* In the search dropdown field, enter _OpenRewrite_ -* Click ![](../.gitbook/assets/select-only.png) to select the search results +- Click the _Select Repositories_ button +- In the search dropdown field, enter _OpenRewrite_ +- Click ![](../.gitbook/assets/select-only.png) to select the search results Now we should see a number in the _Select Repositories_ button indicating how many repositories we to search. @@ -76,8 +76,8 @@ As an example, the screenshot above illustrates how this recipe converts `@Reque The next course of action is to commit the changes. There are a few options available: -* Download a patch ![](../.gitbook/assets/result-diff-download-patch.png) of the change to test locally. -* Create a branch and open a pull request ![](../.gitbook/assets/result-diff-create-branch.png). +- Download a patch ![](../.gitbook/assets/result-diff-download-patch.png) of the change to test locally. +- Create a branch and open a pull request ![](../.gitbook/assets/result-diff-create-branch.png). Clicking ![](../.gitbook/assets/result-diff-create-branch.png) present you with a prompt to select whether or not you wish to create a fork of the project into your personal GitHub. @@ -90,4 +90,3 @@ If you have committer access to the repository, create a branch directly on the {% endhint %} ## Step 9: 🎉 Profit - diff --git a/how-to/creating-your-own-recipes-with-builder.md b/how-to/creating-your-own-recipes-with-builder.md index 962aaf30..c4cfb88e 100644 --- a/how-to/creating-your-own-recipes-with-builder.md +++ b/how-to/creating-your-own-recipes-with-builder.md @@ -15,6 +15,7 @@ Let's build a custom recipe! Let's start with a simple recipe to import. {% code title="sample-recipe.yml" %} + ```text type: specs.openrewrite.org/v1beta/recipe name: org.your_user_name.MyCustomRecipe @@ -25,6 +26,7 @@ recipeList: fullyQualifiedTypeName: java.util.List checkAssignability: true ``` + {% endcode %} 1. Click _Import YAML_ to open form @@ -54,4 +56,3 @@ In the _Recipe Meta Data_ form you can select which repositories to run the reci ## Step 4: Run Recipe Click _Dry Run_ to execute your custom recipe. - diff --git a/how-to/importing-external-recipes.md b/how-to/importing-external-recipes.md index 11074101..f7d8fcfc 100644 --- a/how-to/importing-external-recipes.md +++ b/how-to/importing-external-recipes.md @@ -19,4 +19,3 @@ The artifact information will appear in the table if Moderne.io successfully loc ## Step 3: View recipes in the catalog Your custom recipes will appear in the Catalog and be discoverable through search once successfully deployed. - diff --git a/how-to/importing-projects-from-github.md b/how-to/importing-projects-from-github.md index d2cf599b..31ca0c25 100644 --- a/how-to/importing-projects-from-github.md +++ b/how-to/importing-projects-from-github.md @@ -10,6 +10,9 @@ Click on the _Configure_ link on the left-hand navigation. ### Step 2: Check Moderne.io GitHub App installation status +First-time users may see the following message if the Moderne GitHub App is not configured. +![](../.gitbook/assets/configure-repos-no-repos-found.png) + Click _Add Organization_ to install the GitHub App into one or more of your GitHub organizations and repositories. ### Step 3: Install the Moderne Ingest Action @@ -18,6 +21,8 @@ Select a repository you would like to analyze or transform and click _Set up Git ### Step 4: Create a GitHub Secret using the access token +![](../.gitbook/assets/configure-repos-setup-action.png) + 1. Click _Click to Generate Token_ in the dialog and copy the access token 2. Click on the link in the dialog to go to a repositories' _New Secrets_ form. 3. Enter `MODERNE_API_ACCESS_TOKEN` for the _Secret Name_ @@ -28,12 +33,3 @@ Select a repository you would like to analyze or transform and click _Set up Git ### Step 5: Install the Moderne Ingest GitHub Action Click \_Add `moderne-ingest.yml` button. This action automatically creates a new GitHub Action workflow in the repository. After `moderne-ingest.yml` is installed in the repository, the Ingest process analyzes your code and imports it into Moderne.io. - -## Adding GitHub Action - -![](../.gitbook/assets/configure-repos-setup-action.png) - -![](../.gitbook/assets/configure-repos-no-repos-found.png) - -![](../.gitbook/assets/configure-repos-filter.png) - diff --git a/references/create-api-access-tokens.md b/references/create-api-access-tokens.md index bb87f1a1..e723b00d 100644 --- a/references/create-api-access-tokens.md +++ b/references/create-api-access-tokens.md @@ -39,4 +39,3 @@ Use the name of the token to distinguish it from other tokens. From the _Access Token_ page, click _Delete_ next to the token you wish to revoke. ![](../.gitbook/assets/access-token-remove.png) - diff --git a/references/github-permissions.md b/references/github-permissions.md index ae6856e7..d88716a5 100644 --- a/references/github-permissions.md +++ b/references/github-permissions.md @@ -8,9 +8,8 @@ Moderne.io requires a select number of OAuth scopes necessary to help you transf ![](../.gitbook/assets/authentication-github-permissions.png) -| Permission | Scope | Why we need this | -| :--- | :--- | :--- | -| Repositories \(Public\) | Read/Write | We use this to create branches, create forks of public projects, and push changesets on your behalf. | -| Organizations and teams | Read-only | We use this to understand the organizations you belong to and your level of access within them. | -| Personal user data | Read-only | We use this to recognize your account as a new or returning user. Email and Profile included by default with OpenID Connect through OAuth. | - +| Permission | Scope | Why we need this | +| :---------------------- | :--------- | :----------------------------------------------------------------------------------------------------------------------------------------- | +| Repositories \(Public\) | Read/Write | We use this to create branches, create forks of public projects, and push changesets on your behalf. | +| Organizations and teams | Read-only | We use this to understand the organizations you belong to and your level of access within them. | +| Personal user data | Read-only | We use this to recognize your account as a new or returning user. Email and Profile included by default with OpenID Connect through OAuth. | diff --git a/references/repository-selection.md b/references/repository-selection.md index 12983f54..8049d200 100644 --- a/references/repository-selection.md +++ b/references/repository-selection.md @@ -2,11 +2,10 @@ Before running recipes, selecting repositories can help focus your efforts. Here are some shortcuts available from the repository selection widget: -| Icon | Description | -| :--- | :--- | -| ![Add all repositories to selection ](../.gitbook/assets/select-all.png) | Add all repositories to selection | -| ![Remove all repositories from selection](../.gitbook/assets/remove-all.png) | Remove all repositories from selection | -| ![Add all search results to current repository selection](../.gitbook/assets/add-selected.png) | Add all search results to selection | +| Icon | Description | +| :----------------------------------------------------------------------------------------------------- | :--------------------------------------- | +| ![Add all repositories to selection ](../.gitbook/assets/select-all.png) | Add all repositories to selection | +| ![Remove all repositories from selection](../.gitbook/assets/remove-all.png) | Remove all repositories from selection | +| ![Add all search results to current repository selection](../.gitbook/assets/add-selected.png) | Add all search results to selection | | ![Remove all search results from current repository selection](../.gitbook/assets/remove-selected.png) | Remove all search results from selection | -| ![Only select repositories from search results](../.gitbook/assets/select-only.png) | Select only search results | - +| ![Only select repositories from search results](../.gitbook/assets/select-only.png) | Select only search results |