From a4889468fb92252ed9af742a5e49cd5a2443c780 Mon Sep 17 00:00:00 2001 From: Derick Sozo Date: Thu, 7 Sep 2023 14:57:19 +0700 Subject: [PATCH 1/2] (docs): 1. Grammar / Spelling fixes for the Sync With GitHub page. 2. Removing image borders and border radius for all images in the documentation. --- docs/getting-started/smart-git-sync.md | 9 +++++---- src/css/custom.css | 6 ------ 2 files changed, 5 insertions(+), 10 deletions(-) diff --git a/docs/getting-started/smart-git-sync.md b/docs/getting-started/smart-git-sync.md index ebeffc3e..bcc4ccdc 100644 --- a/docs/getting-started/smart-git-sync.md +++ b/docs/getting-started/smart-git-sync.md @@ -10,7 +10,7 @@ slug: /smart-git-sync Amplication provides a powerful feature known as _Smart Git Sync_ for syncing the code produced from your project with a git repository. Smart Git Sync automatically synchronizes any changes made on your project to your preferred git repository. -This is achieved creating an `amplication` branch that contains all new commits generated by changes and additions on your Amplication project. +This is achieved by creating an `amplication` branch that contains all new commits generated by changes and additions on your Amplication project. Amplication offers _Smart Git Sync_ for everyone including Free, Pro, and Enterprise plan users. @@ -62,7 +62,7 @@ For example, Amplication will base the `amplication` branch from `main` if your You can merge Amplication-made changes by merging pull requests created by Amplication from the `amplication` branch to your repository's default branch. :::note -Refrain from modifying the `amplication` branch. Creating new commits or merging changes from other branches can introduce bugs and inconsistencies. In case of conflict, delete the `amplication` branch and resolve the merge conflict in the next PR. +Refrain from modifying the `amplication` branch directly. Creating new commits or merging changes from other branches can introduce bugs and inconsistencies. In case of conflict, delete the `amplication` branch and resolve the merge conflict in the next PR. ::: ![](./assets/sync-with-git-provider/github-pull-request.png) @@ -71,9 +71,10 @@ Refrain from modifying the `amplication` branch. Creating new commits or merging Every time a build process is completed in Amplication, Smart Git Sync produces a build message that provides valuable insight into the actions taken during the build. These build messages are automatically included in the commit messages in your Git repository. -Amplication handles commit messages and pull requests in a manner that promotes clarity and efficient tracking of changes. +Amplication handles commit messages and pull requests in a manner that promotes clarity and efficient tracking of changes: -If there isn't an open pull request from the `amplication` branch when a commit is made, Amplication will automatically create one. The title of this pull request and the commit message both come from the input you provide in the commit message box in Amplication's pending changes section. +- If there isn't an open pull request from the `amplication` branch when a commit is made, Amplication will automatically create one. +- The title of this pull request and the commit message both come from the input you provide in the commit message box in Amplication's pending changes section. :::note Amplication will generate a default message for your commit if you don't input a message into the pending changes input box. diff --git a/src/css/custom.css b/src/css/custom.css index 9f4e5f2f..cf038572 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -152,12 +152,6 @@ article > header { display: none; } -.markdown img { - margin: 1rem 0; - border: 1px solid var(--black60); - border-radius: 4px; -} - .markdown > h1 { --ifm-h1-font-size: 2rem; } From 82618ab7dd6ff1be09ebbedcde185da1cb0620db Mon Sep 17 00:00:00 2001 From: Derick Sozo Date: Thu, 7 Sep 2023 16:04:50 +0700 Subject: [PATCH 2/2] (docs): Re-uploading some of the images for the Sync With GitHub page and making sure there's no additional whitespace. --- .../getting-started/assets/smart-git-sync.svg | 33 +++++++++++++ .../assets/sync-with-github.svg | 48 +++++++++++++++++++ docs/getting-started/smart-git-sync.md | 4 +- 3 files changed, 83 insertions(+), 2 deletions(-) create mode 100644 docs/getting-started/assets/smart-git-sync.svg create mode 100644 docs/getting-started/assets/sync-with-github.svg diff --git a/docs/getting-started/assets/smart-git-sync.svg b/docs/getting-started/assets/smart-git-sync.svg new file mode 100644 index 00000000..3073c87e --- /dev/null +++ b/docs/getting-started/assets/smart-git-sync.svg @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/getting-started/assets/sync-with-github.svg b/docs/getting-started/assets/sync-with-github.svg new file mode 100644 index 00000000..9ccf51c0 --- /dev/null +++ b/docs/getting-started/assets/sync-with-github.svg @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/getting-started/smart-git-sync.md b/docs/getting-started/smart-git-sync.md index bcc4ccdc..d40eb285 100644 --- a/docs/getting-started/smart-git-sync.md +++ b/docs/getting-started/smart-git-sync.md @@ -17,7 +17,7 @@ Amplication offers _Smart Git Sync_ for everyone including Free, Pro, and Enterp On this page, you'll learn how Smart Git Sync works. You will understand how Amplication manages the `amplication` branch on your repo, creates commits, and initiates pull requests. -![](https://amplication.com/_next/static/media/sync_with_github.ee2ac5a5.svg) +![](./assets/smart-git-sync.svg) ## How Smart Git Sync Works @@ -31,7 +31,7 @@ Amplication supports both [GitHub](/sync-with-github) and [Bitbucket](/sync-with This commit encompasses all the files that were added, removed, or changed since the last build. -![](https://amplication.com/_next/static/media/sync_with_github.1d7a27e3.svg) +![](./assets/sync-with-github.svg) ### Step-by-step breakdown