diff --git a/README.md b/README.md index b4cef668..4b44acbe 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ -# Welcome to Moderne +# Welcome to Moderne.io -You're about to do large-scale refactoring and code improvement without writing a single line of code. Pretty awesome, right? +You're about to do large-scale refactoring and code improvement without writing a single line of code. + +Pretty awesome, right? [Moderne.io ](https://moderne.io)provides customers with an intuitive view for searching, analyzing, and transforming code across their entire organization. -A recipe is designed to transform code at the AST level. While resulting code may look different, the meaning of the code remains the same. +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" %} diff --git a/how-to/importing-projects-from-github.md b/how-to/importing-projects-from-github.md index 1d3cd1d0..27f372f1 100644 --- a/how-to/importing-projects-from-github.md +++ b/how-to/importing-projects-from-github.md @@ -1,7 +1,34 @@ # Importing projects from GitHub +To start performing analysis or code transformations on your projects, Moderne.io integration through our GitHub App and Action. Once connected and configured, your repositories are analyzed through our GitHub Action and imported into Moderne.io. + ## Installing the GitHub App +### Step 1: Go to the _My Organizations & Repositories_ page + +Click on the _Configure_ link on the left-hand navigation. + +### Step 2: Check Moderne.io GitHub App installation status + +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 + +Select a repository you would like to analyze or transform and click _Set up GitHub Action_. + +### Step 4: Create a GitHub Secret using the access token + +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_ +4. Paste in the access token from the dialog into the _Value_ field +5. Click _Add Secret_ +6. Return to the dialog on Moderne.io and click _Continue_ + +### 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) diff --git a/references/create-api-access-tokens.md b/references/create-api-access-tokens.md index e3512e49..e723b00d 100644 --- a/references/create-api-access-tokens.md +++ b/references/create-api-access-tokens.md @@ -1,6 +1,6 @@ # Token Management -Moderne.io offers the ability to Personal Access Tokens \(PATs\) that can be used to directly interface with the Moderne.io GraphQL API. +You can create Personal Access Tokens \(PATs\) for interacting with the GraphQL API. ## Viewing your access tokens @@ -18,18 +18,24 @@ You From [https://app.moderne.io/settings/tokens](https://app.moderne.io/setting ## Creating an access token -### Step 1: Give your token a name / hint +### Step 1: Go to the _Access Token_ page from the account menu + +### Step 2: Name your token + +{% hint style="info" %} +Use the name of the token to distinguish it from other tokens. +{% endhint %} ![This description is useful to help distinguish tokens apart](../.gitbook/assets/access-token-create.png) -### Step 2: Click _Generate_ +### Step 3: Click _Generate_ ![Hint: Click the clipboard icon to copy your access token](../.gitbook/assets/access-token-created.png) -### Step 3: Copy your token +### Step 4: Copy your token to your clipboard ## Revoking an access token -From the Manage Access Token page, click _Delete_ next to the token you wish to revoke. +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 05439478..d88716a5 100644 --- a/references/github-permissions.md +++ b/references/github-permissions.md @@ -1,13 +1,15 @@ # GitHub Permissions +Moderne.io uses a GitHub application to perform various actions on your behalf. Below is an explanation of those permissions and how they're uses by Moderne.io. + ## OAuth Permission -Moderne requires a select number of OAuth scopes necessary to help you transform your code. +Moderne.io requires a select number of OAuth scopes necessary to help you transform your code. ![](../.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 change sets on your behalf. | +| 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 85f7ad6c..8049d200 100644 --- a/references/repository-selection.md +++ b/references/repository-selection.md @@ -1,6 +1,6 @@ # Repository Selection -Selecting repositories before running a recipe can help focus your efforts. Here are some shortcuts available from the repository selection widget: +Before running recipes, selecting repositories can help focus your efforts. Here are some shortcuts available from the repository selection widget: | Icon | Description | | :----------------------------------------------------------------------------------------------------- | :--------------------------------------- |