diff --git a/README.md b/README.md index a776a686..d5c2b11f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ # AL-Go for GitHub +What is AL-Go for GitHub? + +Usage scenarios +- [Create a new per tenant extension (like AL Go) and start developing in VS Code](Scenarios/1.md) + + +# This project This project in the main source repository for AL-Go for GitHub. This project is deployed on every release to a branch in the following repositories: - https://github.com/microsoft/AL-Go-PTE is the GitHub repository template for Per Tenant Extenstions. For creating a Per Tenant Extensions, this is your starting point. @@ -7,9 +14,9 @@ This project in the main source repository for AL-Go for GitHub. This project is and last, but not least a repository with the GitHub actions used by the templates. - https://github.com/microsoft/AL-Go-Actions is the GitHub repository containing the GitHub Actions used by the templates above. -## Contributing +# Contributing -Please read [this document](Contributing.md) to understand how to contribute to AL-Go for GitHub. +Please read [this document](Scenarios/Contributing.md) to understand how to contribute to AL-Go for GitHub. This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us diff --git a/Scenarios/1.md b/Scenarios/1.md new file mode 100644 index 00000000..e8ecfab6 --- /dev/null +++ b/Scenarios/1.md @@ -0,0 +1,17 @@ +# #1 Create a new per tenant extension (like AL Go) and start developing in VS Code +*Pre-requisites: A GitHub account, VS-Code (with AL and PowerShell extensions installed) and Docker installed locally* + +1. Navigate to https://github.com/microsoft/AL-Go-PTE and click **Use this template** +![Use this template](/images/1a.png) +2. Enter **app1** as repository name, select Public or Private and select **Create Repository from template** +3. Select **Actions** -> **Create a new app** -> **Run workflow** +![Run workflow](/images/1b.png) +4. Enter **Name**, **Publisher**, **ID range** and specify **Y** in **Direct COMMIT** and click **Run workflow**. +5. When the workflow is complete, select **< > Code** in the top bar +6. Click the **Code** button and copy the **https Clone Url** (in this picture: *https://github.com/freddydk/App1.git*) +![Clone](/images/1c.png) +7. Start **VS Code**, press **Ctrl+Alt+P** and select **Git Clone**, paste the clone url and select a folder in which you want to clone the directory. +8. **Open the cloned repository** and **open the workspace** when VS Code asks you (or do it manually) +9. In the **.AL-Go** folder, click the **localDevEnv.ps1** script and Run the PowerShell script. +![Local Development Environment](/images/1d.png) +10. Answer the questions asked about container name, authentication mechanism, credentials and select none for license file. The script might popup a dialog asking for permissions to run docker commands, select Yes in this dialog. Wait for completion of the script. diff --git a/Contributing.md b/Scenarios/Contributing.md similarity index 100% rename from Contributing.md rename to Scenarios/Contributing.md diff --git a/Take AL-Go for GitHub for a spin.md b/Take AL-Go for GitHub for a spin.md deleted file mode 100644 index c1c6f85e..00000000 --- a/Take AL-Go for GitHub for a spin.md +++ /dev/null @@ -1,10 +0,0 @@ -# Take AL-Go for GitHub for a spin -## 1. Create a new per tenant extension (like AL Go) and start developing in VS Code -*Pre-requisites: A GitHub account, VS-Code (with AL and PowerShell extensions installed) and Docker installed locally* - -1. Navigate to https://github.com/microsoft/AL-Go-PTE and click **Use this template** -![Use this template](/images/1a.png) -2. Enter **app1** as repository name, select Public or Private and select **Create Repository from template** -3. Select **Actions** -> **Create a new app** -> **Run workflow** - - diff --git a/images/1b.png b/images/1b.png new file mode 100644 index 00000000..19d4905a Binary files /dev/null and b/images/1b.png differ diff --git a/images/1c.png b/images/1c.png new file mode 100644 index 00000000..098a4136 Binary files /dev/null and b/images/1c.png differ diff --git a/images/1d.png b/images/1d.png new file mode 100644 index 00000000..0fa775b9 Binary files /dev/null and b/images/1d.png differ