Skip to content

Enhances the docs for 'how it works' #16

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 31, 2022
Merged

Enhances the docs for 'how it works' #16

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fb2733
Enhance 'how it works' page
Jan 31, 2022
6e1518f
Fix texts
Jan 31, 2022
081724c
Fix the typos for the index of docs
Jan 31, 2022
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
Prev Previous commit
Next Next commit
Fix texts
  • Loading branch information
noah committed Jan 31, 2022
commit 6e1518f9f90303f2dcb87605fd614e65f6a30e4b
4 changes: 2 additions & 2 deletions docs/concepts/how-it-work.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# How it works

Gitploy builds the system around GitHub [deployment API](https://docs.github.com/en/rest/reference/deployments#deployments). Deployment API is a request to deploy a specific ref (branch, SHA, tag), and GitHub dispatches an event to deployment toolings that are listening. **It's an event-driven decoupled way to deploy your code.** This article looks under the hood about how Gitploy interacts with deployment API.
Gitploy builds the system around GitHub [deployment API](https://docs.github.com/en/rest/reference/deployments#deployments). Deployment API is a request to deploy a specific ref (branch, SHA, tag), and GitHub dispatches an event to deployment toolings that can listen for and act on when a request is posted. **It's an event-driven decoupled way to deploy your code.** This article looks under the hood Gitploy interacts with deployment API.


## GitHub Deployment API
Expand Down Expand Up @@ -34,7 +34,7 @@ Gitploy provides the file (i.e., `deploy.yml`) to configure the parameters for e

### Event Dispatch

Gitploy requests to deploy a ref to GitHub, and it dispatches an event to deployment toolings.
Gitploy posts a request to GitHub, and it dispatches an event to deployment toolings.

## Deployment Tooling

Expand Down