Skip to content

Commit

Permalink
doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
justin808 committed Nov 25, 2024
1 parent 692d032 commit 4c4f5ea
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,18 @@
[![Gem](https://badge.fury.io/rb/cpflow.svg)](https://badge.fury.io/rb/cpflow)


Enable the [Heroku Flow](https://www.heroku.com/flow) deployment model with [Control Plane](https://shakacode.controlplane.com) using the `cpflow` gem.
Leverage the power of Kubernetes with the ease of Heroku! The `cpflow` gem enables simple CI configuration for Heroku-style "review apps," staging deployments, and seamless promotion from staging to production. This is similar to the the [Heroku Flow](https://www.heroku.com/flow) deployment model.

Follow the "convention over configuration" philosophy to streamline your deployment workflows and reduce complexity.

----

_If you need a free demo account for Control Plane (no CC required), you can contact [Justin Gordon, CEO of ShakaCode](mailto:[email protected])._

---

Be sure to see the [demo app](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/.controlplane)
If you would like to see the simple YAML configuration and setup,
Be sure to see the [demo app](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/.controlplane), which includes simple YAML configurations and setup for `cpflow`.

Also, check [how the `cpflow` gem (this project) is used in the Github actions](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/.github/actions/deploy-to-control-plane/action.yml).
Here is a brief [video overview](https://www.youtube.com/watch?v=llaQoAV_6Iw).

Expand All @@ -33,11 +35,11 @@ Control Plane's `cpln` CLI.
Heroku provides a UX and CLI that enables easy publishing of Ruby on Rails and other apps. This ease of use comes via
many "Heroku" abstractions and naming conventions.

Control Plane, on the other hand, gives you access to raw cloud computing power. However, you need to know precisely how
to use it.
Control Plane provides access to raw cloud computing power but lacks the simple abstractions of Heroku. The `cpflow` CLI bridges this gap, delivering a streamlined and familiar experience for developers.

While this repository simplifies migration from Heroku, the `cpflow` CLI is versatile and can be used for new applications as well. It follows a **concept mapping** and **helper CLI** approach to streamline deployment workflows and minimize manual effort.

To simplify migration to and usage of Control Plane for Heroku users, this repository provides a **concept mapping** and
a **helper CLI** based on templates to save lots of day-to-day typing (and human errors).
Additionally, the documentation includes numerous examples and practical tips for teams transitioning from Heroku to Kubernetes, helping them make the most of Control Plane's advanced features.

1. [Key Features](#key-features)
2. [Concept Mapping](#concept-mapping)
Expand All @@ -58,8 +60,9 @@ a **helper CLI** based on templates to save lots of day-to-day typing (and human

## Key Features

- A `cpflow` command to complement the default Control Plane `cpln` command with "Heroku style scripting." The Ruby source
can serve as inspiration for your own scripts.
- The `cpflow` CLI complements the Control Plane `cpln` CLI, enabling "Heroku-style scripting" for review apps, staging, and production environments.
- Extensive Heroku-to-Control Plane migration examples included in the documentation.
- Convention-driven configuration to simplify workflows and reduce custom scripting requirements.
- Easy to understand Heroku to Control Plane conventions in setup and naming.
- **Safe, production-ready** equivalents of `heroku run` and `heroku run:detached` for Control Plane.
- Automatic sequential release tagging for Docker images.
Expand Down

0 comments on commit 4c4f5ea

Please sign in to comment.