Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.

Enhance the readability for README.md #220

Merged
merged 3 commits into from
Nov 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 43 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,57 @@
# Gitploy

![test](https://github.com/gitploy-io/gitploy/actions/workflows/test.yaml/badge.svg)
![test](https://github.com/gitploy-io/gitploy/actions/workflows/test.yaml/badge.svg) ![build](https://github.com/gitploy-io/gitploy/actions/workflows/publish.yaml/badge.svg)

![Gitploy](docs/images/gitploy.gif)
<p align="center">
<img src="./docs/images/logo_400.png"><br/>
<b>Gitploy helps your team build the deployment system around GitHub in minutes.</b><br/>
<a href="https://docs.gitploy.io/">Documentation</a> | <a href="https://github.com/gitploy-io/gitploy/discussions">Community</a> | <a href="https://docs.gitploy.io/tasks/installation/">Installation Guide</a>
</p>

---

## What is Gitploy?

Gitploy helps your team or organization builds the system around GitHub in minutes. Gitploy provides these features:
GitHub provides [deployment API](https://docs.github.com/en/rest/reference/repos#deployments) to deploy a specific ref(branch, SHA, tag). It offers strong features to make your team (or organization) can deploy fast and safety. But it takes a lot of resources to build the tool with GitHub deployment API.

Gitploy makes your team or organization build the deployment system around GitHub in minutes. Now, do not waste the time to build the deployment system.

![gitploy](./docs/images/gitploy.gif)


## Features

* Provides the intuitive UI to deploy a specific ref (branch, SHA, tag).
* Build an event-driven deployment system around GitHub. See GitHub [deployment event](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment).
* Integrate with GitHub [Action](https://github.com/features/actions) in minutes.
* Provides deployment features: Rollback, Review, Lock.
* Provides various validations for the deployment.
* Provides DevOps metrics.

## Gitploy vs GitHub environment

* Deploy a specific ref (branch, commit, tag)
* Build an event-driven deployment system around GitHub [deployment API](https://docs.github.com/en/rest/reference/repos#deployments)
* Integrate with GitHub [Action](https://github.com/features/actions) in minutes
Name | Gitploy | GitHub environment
--- |--- |---
Manual deploy | ✅ | ✅
Review | ✅ | ✅
Rollback | ✅ | ❌
Lock environment | ✅ | ❌
Commit statuses validation | ✅ | ❌
Display changed commmits | ✅ | ❌
Private repositories for teams plan | ✅ | ❌ (Enterprise Only)

If you want to look around, you can check the [document](https://docs.gitploy.io) of Gitploy.
## Getting Started

## Docs and Support
To install Gitploy on your hosting, read this [documentation](https://docs.gitploy.io/tasks/installation/).

The documentation to use Gitploy is available at: https://docs.gitploy.io
For public repositories, we're providing the [free cloud](https://github.com/marketplace/gtiploy).

For discussions and questions, post questions or comments to our [community](https://github.com/gitploy-io/gitploy/discussions).
### Important Links

For bugs or errors, [open an issue](https://github.com/gitploy-io/gitploy/issues/new/choose) with details.
Documentation | Community | Installation Guide | Docker Image
--- |--- |--- |---
📚 [Documentation](https://docs.gitploy.io/) |💬 [Community](https://github.com/gitploy-io/gitploy/discussions) |📖 [Installation Guide](https://docs.gitploy.io/tasks/installation/) |🐋 [Docker Image](https://hub.docker.com/repository/docker/gitployio/gitploy)

## Community
## Contributors

You can visit us at Github [Discussions](https://github.com/gitploy-io/gitploy/discussions).
TBD
Binary file added docs/images/logo_400.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 12 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# Gitploy

Gitploy helps your team or organization builds the system around GitHub in minutes. Gitploy provides these features:
## What is Gitploy?

* Deploy a specific ref (branch, commit, tag)
* Build an event-driven deployment system around GitHub [deployment API](https://docs.github.com/en/rest/reference/repos#deployments)
* Integrate with GitHub [Action](https://github.com/features/actions) in minutes
GitHub provides [deployment API](https://docs.github.com/en/rest/reference/repos#deployments) to deploy a specific ref(branch, SHA, tag). It offers strong features to make your team (or organization) can deploy fast and safety. But it takes a lot of resources to build the tool with GitHub deployment API.

Try to build the deployment system with Gitploy ([doc](./tasks/installation.md)).

---
Gitploy makes your team or organization build the deployment system around GitHub in minutes. Now, do not waste the time to build the deployment system.

![Gitploy](./images/gitploy.gif)

## Features

* Provides the intuitive UI to deploy a specific ref (branch, SHA, tag).
* Build an event-driven deployment system around GitHub. See GitHub [deployment event](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment).
* Integrate with GitHub [Action](https://github.com/features/actions) in minutes.
* Provides deployment features: Rollback, Review, Lock.
* Provides various validations for the deployment.
* Provides DevOps metrics.