You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* fixing out of date guidance
Updated contributing guidelines to clarify the process for editing AEP rules and submitting PRs. Removes out-of-date information about the site generator and points to our dedicated repo.
* adding info about our comms channels
slack and gcal moved from readme
* Pointing to the aep.dev site content
Rather than add clicks to journeys (by visiting a .md file and then the website), this helps people get where they need to be faster.
* re-add serve.sh
adds back instructions for the script for running locally and fixes the broken `fix.py` link
* addresses markdown linting issues
Because I was working on a Chromebook, I didn't have an easy way to run the linter on markdown, and the GitHub workflow doesn't give enough insight into what violations it encountered.
Luckily there is an online version of [Prettier](https://prettier.io/playground), so I've used that.
* fix linting issue
1. Create a directory for the aep, and update the aep.yaml file to "approved".
23
-
[Full example PR](https://github.com/aep-dev/aep.dev/pull/77/files).
24
-
1. Modify the content from the aip markdown and paste over the aep.md content.
25
-
- Remove any Google-isms (e.g. replace Google domains with example.com).
26
-
- Extend any proto-specific guidance to include both OpenAPI and proto.
27
-
representations.
28
-
1. Create a GitHub PR. A reviewer should be with you in 24 hours.
29
-
- If a reviewer does not review within that time, please ping @rofrankel or
30
-
@toumorokoshi.
31
-
- Leave comments on any parts of the text that you would like to discuss.
32
-
1. Come say hi in our various communication channels documented in the
33
-
[README](README.md#learn-and-connect).
34
-
35
-
Some tips:
36
-
37
-
- Less is more. If there's a hard disagreement about particular guidance,
38
-
consider filing a follow-up issue to get the agreed upon guidance merged.
39
-
- Perfect is the enemy of good. Feel free to submit PRs that are mostly there,
40
-
and leave questions so reviewers can help address any questions or concerns.
3
+
We welcome patches and contributions to this project.
41
4
42
-
## Development Environment
5
+
## Learn and Connect
43
6
44
-
If you are contributing AEP content (rather than code) and want to be able to
45
-
view it in your browser, the easiest way to do so is to run the site-generator
46
-
script.
7
+
If you'd like to get involved in the AEP community, we'd love to have you! The
8
+
following channels of communication are available:
9
+
10
+
-[The #aep channel in the CNCF Slack](https://cloud-native.slack.com/archives/C04TX46UCTV).
11
+
Sign up at https://slack.cncf.io.
12
+
- We hold a weekly project meeting on Fridays. See
13
+
[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)
14
+
for details. Options for other times, such as more EU-friendly meetings, can
15
+
also be arranged.
16
+
17
+
## Editing AEP Rules
47
18
48
-
We use [GitHub Pages][1] to make this documentation available, and a specific
49
-
[site generator][2] to build the site.
19
+
If you spot a minor issue that seems to be a mistake, such as a typo, please
20
+
make an PR with a fix.
50
21
51
-
Run `./scripts/serve.sh` to:
22
+
For any substantive change or new rule proposal, it is best to search the
23
+
[discussions](https://github.com/aep-dev/aeps/discussions) for similar topics
24
+
before opening a new one. Lighter weight discussions also happen in #aep
25
+
channel in the CNCF Slack is another place or in our weekly Friday calls for
26
+
quick validation of the concept.
52
27
53
-
- clone the site-generator repository.
54
-
- run the appropriate npm commands.
55
-
- begin the dev server at port 4321.
28
+
Once there is a clear point of view articulated and some amount of support
29
+
gathered, the next step would be to open a PR to reference the discussion and
30
+
describe the work to be done. Any subsequent pull request should then reference
31
+
the issue and will enter the queue for review.
56
32
57
-
### Hot reloading
33
+
## Development Environment
34
+
35
+
If you are contributing AEP content (rather than code) and want to be able to
36
+
view it in your browser, the easiest way to do so is to run
37
+
`./scripts/serve.sh` to:
58
38
59
-
The development server currently does not support hot reloading.
39
+
- clone the [site-generator project](https://github.com/aep-dev/site-generator)
40
+
repository
41
+
- run the appropriate npm commands
42
+
- begin the dev server at port 4321
60
43
61
44
### Updating examples
62
45
@@ -73,7 +56,8 @@ Specifically, the following files are copied over:
73
56
### Formatting
74
57
75
58
This repository uses [prettier](https://prettier.io/) and a bespoke script
76
-
[scripts/fix.py](scripts/fix.py). Please check the
Copy file name to clipboardExpand all lines: README.md
+4-10Lines changed: 4 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,12 @@ of clients and tooling for protobuf and HTTP REST APIs.
5
5
6
6
## Overview
7
7
8
-
See [GOVERNANCE.md](./GOVERNANCE.md).
8
+
See [Governance](https://aep.dev/governance/).
9
9
10
-
## Learn and Connect
10
+
## Get Involved
11
11
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:
14
-
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
0 commit comments