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

Commit 615e74f

Browse files
author
Noah Lee
authored
Add the FAQ documentation (#266)
* Add a quick start. * Add FAQ * Fix the link of deployment API
1 parent b1c8fde commit 615e74f

File tree

6 files changed

+26
-3
lines changed

6 files changed

+26
-3
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
## What is Gitploy?
1616

17-
GitHub provides the [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 deployment system around GitHub deployment API.**
17+
GitHub provides the [deployment API](https://docs.github.com/en/rest/reference/deployments#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 deployment system around GitHub deployment API.**
1818

1919
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.
2020

docs/concepts/deploy.yml.md

+13
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
Gitploy configures a pipeline with a simple, easy‑to‑read file that you commit to your git repository. *The configuration file must be at the head of the default branch.* The default path is `deploy.yml` at the root directory, but you can replace the file path in the settings tab of Gitploy. You can check the [documentation](../references/deploy.yml.md) for the specification of the configuration file and also references [Use Cases](../tasks/usecases.md).
44

5+
## Quick Start
6+
7+
If you want to get started quickly, you should copy the `deploy.yml` file and push it into your git repository. Then you find the environment in the Gitploy.
8+
9+
```yaml
10+
# deploy.yml
11+
envs:
12+
- name: production
13+
auto_merge: false
14+
# To avoid the context verification.
15+
# required_context: []
16+
```
17+
518
## Features
619
### Multi Environment
720

docs/concepts/how-it-work.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# How it works
22

3-
Gitploy builds the system around GitHub [deployment API](https://docs.github.com/en/rest/reference/repos#deployments). **It's an event-driven decoupled way to deploy your code.** Internally, Gitploy creates a new Github deployment resource, and Github dispatches a deployment event that external services can listen for and act. It enables developers and organizations to build loosely coupled tooling.
3+
Gitploy builds the system around GitHub [deployment API](https://docs.github.com/en/rest/reference/deployments#deployments). **It's an event-driven decoupled way to deploy your code.** Internally, Gitploy creates a new Github deployment resource, and Github dispatches a deployment event that external services can listen for and act. It enables developers and organizations to build loosely coupled tooling.
44

55
This approach has several pros:
66

docs/faq.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# FAQ
2+
3+
**I tried to deploy, and the deployment status has been pending as `created` for a while.** What should I do?
4+
5+
Don't worry. Gitploy transit the deployment status into `canceled` if pending (i.e. `created` or `waiting`) for thirty minutes.
6+
7+
## Questions?
8+
9+
We are always happy to help with questions you might have. Search our documentation or check out answers to common questions. You can also post questions or comments to our [community](https://github.com/gitploy-io/gitploy/discussions).

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## What is Gitploy?
44

5-
GitHub provides the [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 deployment system around GitHub deployment API.
5+
GitHub provides the [deployment API](https://docs.github.com/en/rest/reference/deployments#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 deployment system around GitHub deployment API.
66

77
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.
88

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ nav:
3030
- References:
3131
- Configurations: references/configurations.md
3232
- "deploy.yml": references/deploy.yml.md
33+
- FAQ: faq.md
3334
- Contributing: contributing.md
3435
extra:
3536
social:

0 commit comments

Comments
 (0)