Skip to content

Commit

Permalink
(docs): Writing documentation premium features pages for the followin…
Browse files Browse the repository at this point in the history
…g pages: Custom Git Base Branch, Enterprise Git Providers, and Private Plugins.
  • Loading branch information
dericksozo committed Nov 16, 2023
1 parent 9c2031c commit 9644806
Show file tree
Hide file tree
Showing 5 changed files with 134 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions docs/premium-features/custom-base-branch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Use A Custom Git Base Branch
sidebar_label: Custom Git Base Branch
slug: /enterprise-git-custom-base-branch
---

# Use A Custom Git Base Branch

Enterprise plan users of Amplication can enhance their workflow by using our Git Base Branch feature. This lets you direct pull requests to a specific branch of your choice to accomodate various development workflows. For example, feature branching or environment-specific branches.

## Understanding the Custom Git Base Branch Feature

The base branch is where all the changes from other branches are merged into. By default, Amplication targets the `main` or `master` branch for pull requests. However, with this feature, users can redirect pull requests to any branch, like a development or staging branch, before they reach the main branch.

## Benefits of Using A Custom Git Base Branch

- **Workflow Flexibility**: Align pull requests with your existing Git workflow, whether it's GitFlow, GitHub Flow, or any custom process you've adopted.
- **Environment Management**: Facilitate environment-specific branches for development, testing, staging, or production, managing your deployment pipeline more effectively.
- **Team Collaboration**: Coordinate team efforts by segmenting features or releases into dedicated branches, streamlining review and integration processes.

## How to Configure Your Custom Base Branch

Here’s how you can set up a custom Git base branch for your projects and services:

### For Entire Projects

1. Navigate to your **project's Git Settings** page.
2. Locate the **Base Branch** text field.
3. Input the desired branch name you want Amplication to use for pull requests.
4. The new base branch is saved automatically when you click out of the text field.

### For Individual Services

1. Go to your **service's Git Settings** page.
2. Activate the `Override default settings` toggle.
3. Re-select your connected Git repository if required.
4. Find the **Base Branch** text field.
5. Type in the branch name you wish Amplication pull requests to target.
6. The new base branch is saved once you click out of the text field.

For comprehensive guidance on changing your base branch for pull requests and more details on Git provider integration, please refer to the [How To Change Base Branch For Pull Requests](/how-to/change-base-branch-for-pull-requests) documentation.
47 changes: 47 additions & 0 deletions docs/premium-features/enterprise-git-providers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: Enterprise Git Providers
sidebar_label: Additional Git Providers
slug: /enterprise-git-providers
---

# Enterprise Git Providers

Amplication extends its support beyond GitHub to include additional Git providers like [Bitbucket](/sync-with-bitbucket) and [AWS CodeCommit](/sync-with-aws-codecommit) for users on the Enterprise plan.
Organizations can integrate with their git provider to leverage the Git workflows they are already accustomed to.

![Sync With Git Providers Enterprise](./assets/enterprise-sync-with-git-providers.png)

:::note
This feature is exclusive to users on Amplication's **Enterprise plan**. Free plan users get access to [GitHub](/sync-with-github).
:::

## Available Git Providers

Apart from GitHub, Amplication's Enterprise plan users can choose to integrate with the following Git providers:

- [**Bitbucket**](/sync-with-bitbucket): Ideal for teams already using Atlassian products, offering seamless integration with Jira and Trello.
- [**AWS CodeCommit**](/sync-with-aws-codecommit): A fully-managed source control service that hosts secure Git-based repositories, perfect for users deeply integrated with the AWS ecosystem.

## Benefits of Integrating with Enterprise Git Providers

- **Flexibility**: Connect with the Git provider that aligns with your organization's workflow and toolchain.
- **Control**: Maintain full ownership and control of your codebase, regardless of where it is hosted.
- **Security**: Leverage the security features offered by Bitbucket and AWS CodeCommit for your source code management.
- **Collaboration**: Utilize familiar pull request and code review processes to enhance team collaboration and code quality.

## Changing Git Providers

Switching between Git providers on Amplication is straightforward and can be managed per service or at the project level. Here's how to change your Git provider for an existing service:

1. Navigate to your service's dashboard on Amplication.
2. Access the _Sync with Git Provider_ section via the sidebar or the project's dashboard.
3. Click on the `Select organization` dropdown.
4. To add a new organization or account, click on the `Add Organization` button at the bottom of the dropdown.
5. In the _Select Git Provider_ modal, choose your new Git provider and click `Connect`.
6. Follow the authorization steps required by the selected Git provider to allow Amplication access.
7. Once authorized, select an existing repository from the list provided or create a new one directly through the modal.

For detailed instructions on how to sync with Bitbucket or AWS CodeCommit, please refer to their specific documentation pages on Amplication:

- [Sync with Bitbucket](/sync-with-bitbucket)
- [Sync With AWS CodeCommit](/sync-with-aws-codecommit)
42 changes: 42 additions & 0 deletions docs/premium-features/private-plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Private Plugins for Enterprise
sidebar_label: Private Plugins
slug: /enterprise-private-plugins
---

# Private Plugins for Enterprise

Amplication's Enterprise plan includes a powerful feature for organizations that require custom functionality and enhanced privacy: **Private Plugins**.
This feature allows enterprise users to create proprietary plugins that are accessible only within their organization.
This lets you do deep integration with internal systems and workflows.

## Private Plugins vs Community Plugins

Private plugins are similar to [community plugins](/getting-started/plugins/) but are hosted in a private, secure environment exclusive to your enterprise. These plugins enable organizations to extend the functionality of their generated applications with custom integrations and proprietary business logic.

## Benefits of Private Plugins

- **Customization**: Tailor plugins to fit exact enterprise requirements, whether for connecting to bespoke internal systems or providing unique functionality.
- **Security and Privacy**: Keep your code and integrations secure within your organization's private repository, safeguarding sensitive business logic and data.
- **Controlled Distribution**: Manage access to your plugins, ensuring only authorized personnel can install and configure them.
- **Seamless Integration**: Ensure compatibility with your enterprise architecture, providing a consistent development and deployment experience.
release cycles, ensuring stability and compatibility with your applications.

## Creating and Managing Private Plugins

Enterprise teams can create private plugins using the following steps:

1. Navigate to the _Private Plugins_ section within your enterprise dashboard.
2. Click on **Create New Plugin** to initiate a new private plugin project.
3. Provide the necessary details such as the plugin's name, description, and configuration options.
4. Develop your [custom plugin](/plugins/how-to-create-plugin/) using Amplication’s development framework, ensuring that it adheres to your internal coding standards and security requirements.
5. Once development is complete, submit the plugin for a review to ensure it meets organizational guidelines and functionality.
6. After approval, the plugin becomes available for installation across your enterprise projects.

## Installing and Using Private Plugins

To use a private plugin in your Amplication projects:

1. From the _Private Plugins_ page, select the plugin you want to install.
2. Click on **Install**, and the plugin will be included in your service.
3. Configure the plugin as necessary, with settings specific to the needs of the service.
5 changes: 4 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,10 @@ const sidebars = {
items: [
"how-to/enterprise-sso",
"how-to/git-branch-per-service",
"how-to/code-generator-version-control"
"how-to/code-generator-version-control",
"premium-features/enterprise-git-providers",
"premium-features/custom-base-branch",
"premium-features/private-plugins"
]
},
{
Expand Down

0 comments on commit 9644806

Please sign in to comment.