Skip to content

Commit e5f4b55

Browse files
committed
chore: update docs for clarity
1 parent a0c3428 commit e5f4b55

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
[![GitHub release](https://img.shields.io/github/v/release/micovery/apigee-go-gen)](https://github.com/micovery/apigee-go-gen/releases)
2020
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2121

22-
The `apigee-go-gen` tool streamlines your Apigee development experience using [Go style](https://developer.hashicorp.com/nomad/tutorials/templates/go-template-syntax) templates with a YAML-First approach.
22+
The `apigee-go-gen` CLI tool streamlines your Apigee development experience using [Go style](https://developer.hashicorp.com/nomad/tutorials/templates/go-template-syntax) templates with a YAML centric workflow.
2323

2424
**Here's what you'll find:**
2525

docs/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
[![GitHub release](https://img.shields.io/github/v/release/micovery/apigee-go-gen)](https://github.com/micovery/apigee-go-gen/releases)
2020
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2121

22-
The `apigee-go-gen` tool streamlines your Apigee development experience using [Go style](https://developer.hashicorp.com/nomad/tutorials/templates/go-template-syntax) templates with a [YAML-First](#why-use-yaml-first) approach.
22+
The `apigee-go-gen` CLI tool streamlines your Apigee development experience using [Go style](https://developer.hashicorp.com/nomad/tutorials/templates/go-template-syntax) templates with a YAML centric workflow.
2323

2424
**Here's what you'll find:**
2525

@@ -29,9 +29,9 @@ The `apigee-go-gen` tool streamlines your Apigee development experience using [G
2929
By using this tool alongside the [Apigee CLI](https://github.com/apigee/apigeecli), you'll unlock a highly customizable workflow. This is perfect for both streamlined local development and robust CI/CD pipelines.
3030

3131

32-
## Why use YAML-First
32+
## Why use YAML
3333

34-
The API proxy bundle format has certain characteristics that can present challenges:
34+
The traditional Apigee API proxy bundle format has certain characteristics that can present challenges:
3535

3636
* **XML Format**: XML is a polarizing format. While it offers advantages like legacy tooling
3737
support and well-defined schema validation, its verbosity can make it less ideal for smaller configuration files.
@@ -40,9 +40,9 @@ The API proxy bundle format has certain characteristics that can present challen
4040
limiting flexibility in terms of re-use and customization. This often leads Apigee customers to develop their
4141
own systems to manage, adapt, and deploy these bundles across environments.
4242

43-
What if there was a better way? ...
43+
**What if there was a better way?** ...
4444

45-
I propose using YAML to represent API Proxies in combination with a powerful Go style templating engine.
45+
You can define Apigee API Proxies using YAML configuration files and customize them with a flexible templating system.
4646

4747
This approach has the potential to address the current challenges, offering:
4848

docs/transform/commands/apiproxy-to-yaml.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ apigee-go-gen transform apiproxy-to-yaml \
5252
## API Proxy Bundle Structure
5353
In the Apigee world, API proxy bundles are like the packages that hold all the instructions your API needs to work.
5454

55+
**How are API proxy bundles used?** ...
56+
5557
- [x] **Creating APIs**
5658
> When you design an API using the Apigee X UI and download the zip file, you're actually getting an API proxy bundle.
5759
- [x] **Deploying APIs**

0 commit comments

Comments
 (0)