Skip to content

Commit 4c4f5ea

Browse files
committed
doc improvements
1 parent 692d032 commit 4c4f5ea

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,18 @@
1212
[![Gem](https://badge.fury.io/rb/cpflow.svg)](https://badge.fury.io/rb/cpflow)
1313

1414

15-
Enable the [Heroku Flow](https://www.heroku.com/flow) deployment model with [Control Plane](https://shakacode.controlplane.com) using the `cpflow` gem.
15+
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.
16+
17+
Follow the "convention over configuration" philosophy to streamline your deployment workflows and reduce complexity.
1618

1719
----
1820

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

2123
---
2224

23-
Be sure to see the [demo app](https://github.com/shakacode/react-webpack-rails-tutorial/tree/master/.controlplane)
24-
If you would like to see the simple YAML configuration and setup,
25+
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`.
26+
2527
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).
2628
Here is a brief [video overview](https://www.youtube.com/watch?v=llaQoAV_6Iw).
2729

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

36-
Control Plane, on the other hand, gives you access to raw cloud computing power. However, you need to know precisely how
37-
to use it.
38+
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.
39+
40+
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.
3841

39-
To simplify migration to and usage of Control Plane for Heroku users, this repository provides a **concept mapping** and
40-
a **helper CLI** based on templates to save lots of day-to-day typing (and human errors).
42+
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.
4143

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

5961
## Key Features
6062

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

0 commit comments

Comments
 (0)