diff --git a/README.md b/README.md index c78b9f4..975102b 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ [![GitHub release](https://img.shields.io/github/v/release/micovery/apigee-go-gen)](https://github.com/micovery/apigee-go-gen/releases) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -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. +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. **Here's what you'll find:** diff --git a/docs/index.md b/docs/index.md index 79e7d5d..01bf230 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,7 +19,7 @@ [![GitHub release](https://img.shields.io/github/v/release/micovery/apigee-go-gen)](https://github.com/micovery/apigee-go-gen/releases) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -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. +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. **Here's what you'll find:** @@ -29,9 +29,9 @@ The `apigee-go-gen` tool streamlines your Apigee development experience using [G 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. -## Why use YAML-First +## Why use YAML -The API proxy bundle format has certain characteristics that can present challenges: +The traditional Apigee API proxy bundle format has certain characteristics that can present challenges: * **XML Format**: XML is a polarizing format. While it offers advantages like legacy tooling 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 limiting flexibility in terms of re-use and customization. This often leads Apigee customers to develop their own systems to manage, adapt, and deploy these bundles across environments. -What if there was a better way? ... +**What if there was a better way?** ... -I propose using YAML to represent API Proxies in combination with a powerful Go style templating engine. +You can define Apigee API Proxies using YAML configuration files and customize them with a flexible templating system. This approach has the potential to address the current challenges, offering: diff --git a/docs/transform/commands/apiproxy-to-yaml.md b/docs/transform/commands/apiproxy-to-yaml.md index 6f63a84..0c7fc54 100644 --- a/docs/transform/commands/apiproxy-to-yaml.md +++ b/docs/transform/commands/apiproxy-to-yaml.md @@ -52,6 +52,8 @@ apigee-go-gen transform apiproxy-to-yaml \ ## API Proxy Bundle Structure In the Apigee world, API proxy bundles are like the packages that hold all the instructions your API needs to work. +**How are API proxy bundles used?** ... + - [x] **Creating APIs** > When you design an API using the Apigee X UI and download the zip file, you're actually getting an API proxy bundle. - [x] **Deploying APIs**