Skip to content

Commit d707c71

Browse files
Resolved PR comments
1 parent c05afd7 commit d707c71

File tree

4 files changed

+9
-15
lines changed

4 files changed

+9
-15
lines changed

docs/main/02-intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ With Promises, domain specialists can guarantee that every service request adher
4848
### Application Developers
4949
Many application teams face delays waiting for essential platform services, leading to poor developer experience (DevEx), workarounds, shadow IT, and missed deadlines. The additional concerns—such as infrastructure, networking, security policies, and billing limits—can overwhelm teams, diverting focus from delivering value.
5050

51-
Effective platforms minimize cognitive load by offering everything-as-a-service with built-in business rules and policies. Kratix and Promises enable this while allowing Platform teams to provide services at the right level of abstraction—hiding complexity from those who don’t need to manage it.
51+
Effective platforms minimise cognitive load by offering everything-as-a-service with built-in business rules and policies. Kratix and Promises enable this while allowing Platform teams to provide services at the right level of abstraction—hiding complexity from those who don’t need to manage it.
5252

5353
## Kratix in action
5454
Watch how Kratix supports teams using Backstage to provide anything-as-a-service.

docs/main/03-reference/11-promises/01-intro.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Documentation for the Kratix Promise Custom Resource
66

77
# Promises
88

9-
At the core of Kratix are Promises. Promises are a set of instructions written in YAML that will produce a [resource](../resources/intro) whenever the Promise is invoked. This means that you can run software-as-a-service from your platform. A Promise consists of an API description of how to provision the dependencies required to fulfill that promise, the workflows that define how the provisioning takes place, and destination rules that allow the Promise Author to determine where resources should go.
9+
At the core of Kratix are Promises. Promises are a set of instructions written in YAML that will produce a [resource](../resources/intro) whenever the Promise is invoked. This means that you can run software-as-a-service from your platform. A Promise consists of the dependencies it must setup before the Promise can be requested, an API description of how a user can request that Promise, the workflows that define how the provisioning takes place, and destination rules that allow the Promise Author to determine where resources should go.
1010

1111
This introduction is intended for platform engineers and people creating promises for use by the rest of their organisation.
1212

@@ -140,7 +140,7 @@ For example, if the Promise describes a database, a Jenkins installation, and an
140140
Dependencies are everything that the Promise relies on to function. A Kratix Promise can even be built on other Kratix Promises. A dependency is the pre-requisite software to create the resource and make it operational. A dependency might be a low-level resource such as a database, a pre-defined environment, a connection, a queue, or a bundle of related items that work together.
141141
142142
### Workflows
143-
Workflows are the actions that must run in order to fulfill a Promise. They are a chain of containers that execute in sequence to fulfill the promise specifications, including responses to API specifications, notifications, business rules, and custom specifications.
143+
Workflows are the actions that must run in order to fulfil a Promise. They are a chain of containers that execute in sequence to fulfill the promise specifications, including responses to API specifications, notifications, business rules, and custom specifications.
144144
145145
The Promise workflows are run as part of the Promise lifecycle, and the Resource workflows are run as part of the Resource lifecycle. Under both Promise and Resource workflows, Kratix supports two workflow types:
146146
- The `configure` workflows runs when either the Promise or Resource is created, updated or reconciled.

docs/main/03-reference/11-promises/02-create.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Documentation on creating a Promise
55
---
66

77
## Getting Started
8-
When you start using Kratix, many people install a Marketplace Promise to experiment with. As you use it, it may become clear that you need a more customised solution.
8+
When getting started with Kratix, many people install a Marketplace Promise to experiment with. As you use it, it may become clear that you need a more customised solution.
99

1010
You clone the Promise and tweak the Promise description to apply to your own environment. You then install it so the Promise is available for request.
1111

@@ -16,9 +16,9 @@ We suggest these examples as good starting places:
1616
- [Promise writing guide](../../../workshop/part-ii/writing-your-first-promise)
1717

1818
## Creating a Promise
19-
You create a Promise by assembling a YAML file which defines all the dependencies and workflows that the Promise will include. It also defines the API that is used to request a resource. The Promise can have a mix of static and configurable resources, or other Kratix Promises. Once the Promise is written, it needs to be installed so that the resources it refers to will be available when a user requests them.
19+
You create a Promise by assembling a YAML file which defines all the dependencies and workflows that the Promise will include. It also defines the API that is used to request a resource. Once the Promise is written, it needs to be installed so that the dependencies it refers to will be available when a user requests them.
2020

21-
This example of a Promise contains all the essential elements. For Promises that have more complexity, you can see the Promise Marketplace.
21+
Below is an example of a Promise contains all the essential elements. For Promises that have more complexity, you can see the Promise Marketplace.
2222

2323
First, there is the metadata that describes the Promise name, version, and labels.
2424

@@ -45,7 +45,7 @@ Dependencies are all the things required for the platform to run the Promise. Fo
4545
name: promise-example
4646
```
4747

48-
The API is how the user creates and customises their resources. The API can create, update, or delete promise instances. Users can also use the API to customise the Promise request in ways made available by the Promise. For example, the container image of a resource or its size.
48+
The API is how the user creates and customises their resources. Using the API, application teams can create, update, or delete promise instances. Users can also use the API to customise the Promise request in ways made available by the Promise. For example, the container image of a resource or its size.
4949

5050
```
5151
api:
@@ -77,7 +77,7 @@ The API is how the user creates and customises their resources. The API can crea
7777
storage: true
7878
```
7979

80-
Workflows are a set series of containers executed in sequence. Putting the actions in containers allows them to be consistent and reusable. Containerising the actions allows for maximum flexibility in language and modularity while maximising testability.
80+
Workflows are a series of containers executed in sequence. Putting the actions in containers allows them to be consistent and reusable. Containerising the actions allows for maximum flexibility in language and modularity while maximising testability.
8181

8282
```
8383
workflows:
@@ -109,4 +109,4 @@ Workflows are a set series of containers executed in sequence. Putting the actio
109109

110110
## Installing a Promise
111111

112-
Installing a Promise is a simple application of the Promise YAML file to the platform cluster. The API is then available for users to call, promise-workflows execute, and the dependencies are installed and made available so that the Promise can be fulfilled when it is requested. A promise exists on the platform cluster and can be called to create an identical promise instance at any time.
112+
Installing a Promise is a simple application of the Promise YAML file to the platform cluster. The API is then available for users to call, promise-workflows execute, and the dependencies are installed and made available so that the Promise can be fulfilled when it is requested. A promise exists on the platform cluster and can be called to create an consistent promise instance at any time.

docs/main/03-reference/11-promises/04-delete.md

-6
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,6 @@ sidebar_label: Deleting
55
---
66
Deleting a Promise deletes both the Promise and all the resources and dependencies associated with it. Deleting a Promise runs the specific delete workflow that is declared in the Promise. Once the delete workflow runs, the resources uniquely associated with that Promise are removed from the platform and finally the Promise itself is removed from the platform.
77

8-
:::caution
9-
10-
Deleting a Promise will cascade delete all the associated requested Resources and Dependencies.
11-
12-
:::
13-
148
To delete a Promise, run the command below, making sure to replace the
159
`<promise name>` with the Promise you want to remove:
1610

0 commit comments

Comments
 (0)