Skip to content

Commit 667b74b

Browse files
authored
fixing out of date guidance (#392)
* 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 parent 34d637c commit 667b74b

2 files changed

Lines changed: 39 additions & 61 deletions

File tree

CONTRIBUTING.md

Lines changed: 35 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,45 @@
11
# Contributing
22

3-
We'd love to accept your patches and contributions to this project.
4-
5-
## Importing an AEP from google.aip.dev
6-
7-
Currently, the project is focused on adopting AIPs from
8-
https://google.aip.dev/. You can contribute!
9-
10-
You can
11-
[watch the video walkthrough](https://drive.google.com/file/d/1hCBxfTJPINVUpTLnzccJy4pFXZhQQMd3/view?usp=sharing),
12-
or follow the step by step guide:
13-
14-
1. [Select an AIP to adopt into an AEP from the open issues with the label "adoption"](https://github.com/aep-dev/aep.dev/labels/adoption).
15-
- Consider
16-
[ones also with the label "good first issue"](https://github.com/aep-dev/aep.dev/issues?q=is%3Aopen+label%3A%22good+first+issue%22+label%3Aadoption).
17-
1. Navigate to the
18-
[GitHub Repository](https://github.com/aip-dev/google.aip.dev), and find the
19-
AIP in the
20-
[general directory](https://github.com/aip-dev/google.aip.dev/tree/master/aip/general).
21-
Copy the raw content.
22-
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.
414

42-
## Development Environment
5+
## Learn and Connect
436

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
4718

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.
5021

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.
5227

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.
5632

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:
5838

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
6043

6144
### Updating examples
6245

@@ -73,7 +56,8 @@ Specifically, the following files are copied over:
7356
### Formatting
7457

7558
This repository uses [prettier](https://prettier.io/) and a bespoke script
76-
[scripts/fix.py](scripts/fix.py). Please check the
59+
[scripts/fix.py](https://github.com/aep-dev/aeps/blob/main/scripts/fix.py).
60+
Please check the
7761
[lint.yaml](https://github.com/aep-dev/aeps/blob/main/.github/workflows/lint.yaml)
7862
for the specific file.
7963

README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,12 @@ of clients and tooling for protobuf and HTTP REST APIs.
55

66
## Overview
77

8-
See [GOVERNANCE.md](./GOVERNANCE.md).
8+
See [Governance](https://aep.dev/governance/).
99

10-
## Learn and Connect
10+
## Get Involved
1111

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
19-
attend!
12+
There are lots of ways to contribute! See:
13+
[Contributing](https://aep.dev/contributing/)
2014

2115
## License
2216

0 commit comments

Comments
 (0)