Skip to content

Commit b5472b2

Browse files
committed
Update README.md to clarify AEP purpose and contribution instructions
1 parent c4314aa commit b5472b2

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
# API Enhancement Proposals
22

3-
The [AEP Project](https://aep.dev) is an API design specification and ecosystem
4-
of clients and tooling for protobuf and HTTP REST APIs.
3+
**TL;DR:** AIPs are lots of documents on how we do APIs.
54

65
## Overview
76

8-
See [GOVERNANCE.md](./GOVERNANCE.md).
7+
AEP stands for **API Enhancement Proposal**, which is a design document
8+
providing high-level, concise documentation for API development. The goal is
9+
for these documents to serve as the source of truth for API-related
10+
documentation at Thryv and the way API teams discuss and come to consensus on
11+
API guidance. The program is named and styled after Python's enhancement
12+
proposals (PEPs) which have seemed to work pretty well over the years.
913

10-
## Learn and Connect
14+
## Have an idea for an AEP?
1115

12-
If you'd like to get involved in the AEP community, we'd love to have you! The
13-
following channels of communication are available:
16+
If you **have an idea for an AEP that isn't written yet** (yes, there are
17+
plenty!) check out [Contributing to the project][] to see how you can write
18+
AEPs for others to follow.
1419

15-
- [The #aep channel in the CNCF Slack](https://cloud-native.slack.com/archives/C04TX46UCTV).
16-
Sign up at https://slack.cncf.io.
17-
- [The AEP Google Calendar, to view any upcoming meetings](https://calendar.google.com/calendar/u/0/embed?src=7e35dd3df194a32f4fa7c03a3454e24ba3651e6f568248efe1ddf1e34a7bee9e@group.calendar.google.com&ctz=America/Los_Angeles)
18-
- A weekly project meeting is held, which anyone interested is welcome to
19-
attend!
20+
[contributing to the project]: ./CONTRIBUTING.md
2021

2122
## License
2223

@@ -28,5 +29,7 @@ For the full text of each license, see [`LICENSE.md`](./LICENSE.md). For
2829
additional details, see the developer.google.com [Site Policies][3].
2930

3031
[1]: https://creativecommons.org/licenses/by/4.0/
32+
3133
[2]: https://www.apache.org/licenses/LICENSE-2.0
34+
3235
[3]: https://developers.google.com/terms/site-policies

0 commit comments

Comments
 (0)