Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Smart Git Sync #301

Merged
merged 13 commits into from
Sep 6, 2023
Merged

Smart Git Sync #301

merged 13 commits into from
Sep 6, 2023

Conversation

dericksozo
Copy link
Contributor

(docs): Adding a good draft for Amplication's Smart Git Sync.

@dericksozo dericksozo added the documentation Improvements or additions to documentation label Jun 7, 2023

Amplication provides a powerful feature for Pro and Enterprise plan users called Smart Git Sync (SGS). This feature streamlines the synchronization of any changes made to your preferred Git repository.

SGS does this by creating a `amplication` branch that contains all new commits generated by changes and additions on your Amplication project.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an 'amplication'

Avoid modifying the `amplication` branch. This includes both creating new commits and merging changes from other branches into the 'amplication' branch. Any such action may cause bugs and behavioral inconsistencies, as Amplication will not override or modify the same areas that you changed. To fix this, you will need to delete the 'amplication' branch and resolve the merge conflict in the next PR.
:::

![](./assets/service-entities-roles-permissions/github-pull-request.png)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets use an image with shorter text. the current image shows a very long text that is very hard to understand what it means.


![](./assets/service-entities-roles-permissions/github-pull-request.png)

## The Build Log

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure how everything under the build message relates to the smart git sync.
Also we provide a default message if the user doesn't provide his own.
this functionality works the same for the basic and the smart git

…d Basic Git Sync into one page. Simplifying the language in the amplication section to make it more for users.
@dericksozo
Copy link
Contributor Author

Thanks @GreenMachine01 . I just implemented your feedback. I removed the section on build logs, created a better introduction, and rephrased the amplication branch section.

I'm trying to combine the Smart Git Sync and Basic Git Sync into one section here. My understanding is that they both work essentially the same. The only difference is the Basic Git Sync creates multiple branches. Is that correct?

For Pro and Enterprise plan users, Amplication offers _Smart Git Sync_.
Free users get access to a simplified _Basic Git Sync_.

On this page, you'll learn how Git Sync works and the primary betweens between Smart and Basic.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

between twice. maybe it was supposed to be "differences"

Amplication will generate a default message for your commit if you don't input a message into the pending changes input box.
:::

Additionally, the first comment on the pull request includes a link back to your build in Amplication, presented in a codeblock. Clicking this link will take you back to Amplication to see the build log for this specific commit, offering you a comprehensive overview of the changes that were made during the build.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can remove " presented in a codeblock"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You cant click the link. maybe change "Clicking" to "Using"

@GreenMachine01
Copy link

@dericksozo @mulygottlieb I didn't deep dive but skimmed through it and it looked good to me.
I didn't deep dive since we plan to very soon terminate using the Basic Git sync and move all plans to use the Smart Git sync.

@mulygottlieb
Copy link
Member

@dericksozo - an amplication branch is only created for the smart git sync. On the basic one, we create a branch per PR, which means a branch per each build in our platform. The current explanation about it, and starting by saying that Git Sync (in general) uses an amplication branch, is not accurate.

@dericksozo
Copy link
Contributor Author

Hey @mulygottlieb, thank you for the feedback, but I went ahead and removed mention of Basic Git Sync as per #312. @GreenMachine01 please let me know if this resolves #312.

I apologize about all those extra commits. I was having some issues pushing my local branch for some reason, but I got it resolved.

1. Removing the Differences Between Plans page because it was describing Basic Git Sync vs Smart Git Sync and this is no longer the case.

2. Changing text on the Smart Git Sync page to recommend people to delete the branch.
is also a code-view option, that enables you to view the code in the console before
you download it or move it to GitHub.
you download it or move it to your git provider.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no option to download, please only leave the "push it to your git repository" (which is better than "move it to your git provider" IMO)


---

## Can I work with GitLab (or other git providers) besides GitHub?

Amplication currently supports integration only with GitHub, but we are planning
to add support for more Git providers. See our [Product Roadmap](https://docs.amplication.com/about/roadmap/).
Amplication currently supports integration only with [GitHub](/sync-with-github) and [Bitbucket](/sync-with-bitbucket),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dericksozo I think we need to remove the word "only".

@GreenMachine01 do you want to mention AWS Code Commit as well?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did ask to mention it. I think its part of another PR.

With these new features and improvements in our new version, we make it much easier for you (or your team) to build scalable services, have better control over the generated code and collaborate with multiple developers to work on large scale solutions.

To know more on how to use Amplication to your advantage [Read](https://amplication.com/blog/amplication-version-10-is-now-live)
To know more on how to use Amplication to your advantage [read](https://amplication.com/blog/amplication-version-10-is-now-live) our blog post.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GreenMachine01 do we really want to leave that link to the 1.0 release?

@mulygottlieb mulygottlieb merged commit 09a8dac into main Sep 6, 2023
6 checks passed
@mulygottlieb mulygottlieb deleted the docs/smart-git-sync branch September 6, 2023 16:06
@dericksozo dericksozo mentioned this pull request Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants