jlengrand/moderne-docs
1
0
Fork 0
mirror of https://github.com/jlengrand/moderne-docs.git synced 2026-03-10 08:31:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [master] 3 pages modified

Browse Source
This commit is contained in:
Scott Jungling
2021-08-26 16:36:26 +00:00
committed by gitbook-bot
parent 9e6f593389
commit f8eb9e1859
3 changed files with 24 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
getting-started/signing-in-with-github.md
View File

@@ -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,3 +90,4 @@ If you have committer access to the repository, create a branch directly on the
{% endhint %}
## Step 9: 🎉 Profit

8
how-to/creating-your-own-recipes-with-builder.md
View File

@@ -2,11 +2,11 @@
Moderne provides the ability to create your own custom recipes from our existing recipe catalog through _Recipe_ _Builder._ The Recipe Builder allows you to:
* Import declarative recipes authored in YAML
* Export declarative recipes as YAML and include them in your project
* Remix existing recipes and configurations to meet your goals
1. Import declarative recipes authored in YAML
2. Export declarative recipes as YAML and include them in your project
3. Remix existing recipes and configurations to meet your goals
Let's build a custom recipe!
* Let's build a custom recipe!
Step 1: Import an example recipe

21
references/repository-selection.md
View File

@@ -1,15 +1,12 @@
---
---
# Repository Selection
Selecting repositories before running a recipe can help focus your efforts. Here are some shortcuts available from the repository selection widget:
Selecting repositories before running a recipe 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 |
| ![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 |
| 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 |