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

Commit 237c699

Browse files
author
Noah Hanjun Lee
authored
Enhance the readability for README.md (#220)
* Enhance the README.md * Enhance the index page
1 parent 2826996 commit 237c699

File tree

3 files changed

+55
-20
lines changed

3 files changed

+55
-20
lines changed

README.md

Lines changed: 43 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,57 @@
11
# Gitploy
22

3-
![test](https://github.com/gitploy-io/gitploy/actions/workflows/test.yaml/badge.svg)
3+
![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)
44

5-
![Gitploy](docs/images/gitploy.gif)
5+
<p align="center">
6+
<img src="./docs/images/logo_400.png"><br/>
7+
<b>Gitploy helps your team build the deployment system around GitHub in minutes.</b><br/>
8+
<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>
9+
</p>
10+
11+
---
612

713
## What is Gitploy?
814

9-
Gitploy helps your team or organization builds the system around GitHub in minutes. Gitploy provides these features:
15+
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.
16+
17+
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.
18+
19+
![gitploy](./docs/images/gitploy.gif)
20+
21+
22+
## Features
23+
24+
* Provides the intuitive UI to deploy a specific ref (branch, SHA, tag).
25+
* 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).
26+
* Integrate with GitHub [Action](https://github.com/features/actions) in minutes.
27+
* Provides deployment features: Rollback, Review, Lock.
28+
* Provides various validations for the deployment.
29+
* Provides DevOps metrics.
30+
31+
## Gitploy vs GitHub environment
1032

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

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

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

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

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

23-
For bugs or errors, [open an issue](https://github.com/gitploy-io/gitploy/issues/new/choose) with details.
51+
Documentation | Community | Installation Guide | Docker Image
52+
--- |--- |--- |---
53+
📚 [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)
2454

25-
## Community
55+
## Contributors
2656

27-
You can visit us at Github [Discussions](https://github.com/gitploy-io/gitploy/discussions).
57+
TBD

docs/images/logo_400.png

12.9 KB
Loading

docs/index.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
# Gitploy
22

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

5-
* Deploy a specific ref (branch, commit, tag)
6-
* Build an event-driven deployment system around GitHub [deployment API](https://docs.github.com/en/rest/reference/repos#deployments)
7-
* Integrate with GitHub [Action](https://github.com/features/actions) in minutes
5+
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.
86

9-
Try to build the deployment system with Gitploy ([doc](./tasks/installation.md)).
10-
11-
---
7+
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.
128

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

11+
## Features
12+
13+
* Provides the intuitive UI to deploy a specific ref (branch, SHA, tag).
14+
* 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).
15+
* Integrate with GitHub [Action](https://github.com/features/actions) in minutes.
16+
* Provides deployment features: Rollback, Review, Lock.
17+
* Provides various validations for the deployment.
18+
* Provides DevOps metrics.
19+

0 commit comments

Comments
 (0)