Skip to content

Commit fc6d334

Browse files
committed
Apply suggestions from code review
1 parent c16594d commit fc6d334

File tree

3 files changed

+30
-22
lines changed

3 files changed

+30
-22
lines changed

config/hero.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,8 @@ shortcuts:
2121
text: Contribute to the project
2222
- title: Want to adopt AEPs in your organization?
2323
description: |
24-
AEPs were adapted from [Google's AIP project](https://google.aip.dev/), but also extend it with
25-
tooling to easily generate and validate that result in better designed APIs, as well as provide clients to
26-
consume them.
24+
AEPs were adapted from [Google's AIP project](https://google.aip.dev/), but also enhanced with improved
25+
guidance for APIs, tooling to generate and validate them, and clients to interact with them. The result is better designed and consumable APIs.
2726
button:
2827
href: /adopting
2928
text: Learn more

pages/general/adopting.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
# Adopting AEPs for your company
22

3-
By adopting the guidelines from the API Enhancement Proposals, you establish a much
4-
tighter and efficient possibility space. APIs that follow the
3+
By adopting the guidelines from the API Enhancement Proposals, you establish a
4+
much tighter and efficient possibility space. APIs that follow the
55
[AEP guidance](https://aep.dev) from the design stage:
66

7-
- are more consistent within and across teams, reducing cognitive load for API consumers
8-
- reduce arguments about API design decisions, thanks to the AEP specification, tools, and exemplar design patterns
7+
- are more consistent within and across teams, reducing cognitive load for API
8+
consumers
9+
- reduce arguments about API design decisions, thanks to the AEP specification,
10+
tools, and exemplar design patterns
911

10-
Having an AEP-compliant API also means benefitting from the AEP ecosystem of tooling, such as:
12+
Having an AEP-compliant API also means benefitting from the AEP ecosystem of
13+
tooling, such as:
1114

12-
- Linters and validators to ensure adherence to the AEP design specification [proto]()/[openapi]()
13-
- A command line tool interface genreator that make it easier to work with APIs ([aepcli](https://github.com/aep-dev/aepcli))
14-
- Client-side and server-side code generators ([aepc](https://github.com/aep-dev/aepc))
15-
- A Terraform provider ([terraform-provider-aep](https://github.com/aep-dev/terraform-provider-aep))
16-
- ... and more! Please start a [discussion](https://github.com/aep-dev/aep.dev/discussions) if there is something you wish to see, validate, or prioritize.
15+
- Linters and validators to ensure adherence to the AEP design specification
16+
[proto]()/[openapi]()
17+
- A dynamic command line interface generator that make it easier to work with
18+
APIs ([aepcli](https://github.com/aep-dev/aepcli))
19+
- Client-side and server-side code generators
20+
([aepc](https://github.com/aep-dev/aepc))
21+
- A Terraform provider
22+
([terraform-provider-aep](https://github.com/aep-dev/terraform-provider-aep))
23+
- ... and more! Please start a
24+
[discussion](https://github.com/aep-dev/aep.dev/discussions) if there is
25+
something you wish to see, validate, or prioritize.

pages/general/faq.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
## What are the differences between AEPs and AIPs?
44

5-
If you are familiar with Google's API Improvement Proposals
6-
[google.aip.dev](https://google.aip.dev), then much of the
5+
If you are familiar with Google's API Improvement Proposals
6+
[google.aip.dev](https://google.aip.dev), then much of the
77
[API Enhancement Proposals](https://aep.dev) content will be familiar.
88

99
However, AEPs have notable philosophical differences, including:
1010

11-
- AEPs prioritize broadly applicable design guidance for any company, while AIPs
12-
prioritized design guidance specifically for Google (e.g., providing
11+
- AEPs prioritize broadly applicable design guidance for any company, while
12+
AIPs prioritized design guidance specifically for Google (e.g., providing
1313
backwards-compatibility with prior decisions to meet Google-specific needs).
1414
- AEPs are protocol-agonistic and consider both gRPC and HTTP+JSON as
1515
first-class protocols for which examples and other content are necessary.
16-
- AEPs focuses on a core specification that is not intended to be forked, paired with a
17-
mechanism for optional organization-specific guidance to extend the
18-
specification. AIPs encourage forking its guidance outright.
16+
- AEPs focuses on a core specification that is not intended to be forked,
17+
paired with a mechanism for optional organization-specific guidance to extend
18+
the specification. AIPs encourage forking its guidance outright.
1919

2020
AEPs also have the advantage of hindsight, which makes it possible in some
21-
cases to provide better guidance. (One small example:
22-
renaming `page_size` to `max_page_size` for requests to paginated API methods.)
21+
cases to provide better guidance. (One small example: renaming `page_size` to
22+
`max_page_size` for requests to paginated API methods.)

0 commit comments

Comments
 (0)