Skip to content

Commit 9ee67ca

Browse files
authored
Update README.md
1 parent 73b62dd commit 9ee67ca

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ Check it out and don't forget to ⭐ !
2323

2424
## Demo
2525

26-
![Demo](/docs/assets/demo.gif)
26+
<!-- ![Demo](/docs/assets/demo.gif) -->
2727

2828
Demo repo: [announcement-drafter demo]
2929

3030
## Quickstart Guide
3131

32-
1. [Install the GitHub App](https://github.com/apps/announcement-drafter) and authorize for any repositories or teams you would like it to be able to post to or watch for markdown posts.
32+
1. [Install the GitHub App](https://github.com/apps/announcement-drafter) and authorize it for any repositories or orgs you would like it to watch or post to.
3333
2. Add a `.github/announcement-drafter.yml` (not `.yaml`) configuration file to any repositories you want the bot to watch. [Look here for an example in the demo repo][announcement-drafter demo config]
3434

3535
1. Provide what folders you want the `announcement-drafter` bot to watch and (optionally) what folders you would like it to ignore when new pull requests are open
@@ -39,8 +39,9 @@ Demo repo: [announcement-drafter demo]
3939
- docs/discussions/
4040
```
4141
42-
3. Now whenever you create a pull request with discussion markdown in those watch folders, `announcement-drafter` will ask for approvals to create discussions, and when the pull request is merged, it will create the discussions and post as the pull request author!
43-
4. See [Usage](#usage) for more specific usage instructions
42+
3. Now whenever you create a pull request with [discussion markdown](#discussion-markdown) in those watch folders, `announcement-drafter` will ask for approvals to create the discussion
43+
4. When the pull request is merged, it will create the discussion *as the pull request author*!
44+
5. See [Usage](#usage) for more specific usage instructions
4445

4546
## Usage
4647

@@ -72,7 +73,7 @@ watch_folders:
7273

7374
#### Examples
7475

75-
See the [demo repository](https://github.com/philip-gai/announcement-drafter-demo/blob/main/docs/demo) for more.
76+
See the [demo repository](**https**://github.com/philip-gai/announcement-drafter-demo/blob/main/docs/demo) for more.
7677

7778
##### Draft a Repository Discussion
7879

@@ -110,21 +111,22 @@ Hello beautiful world! 🌎
110111
| `repository` | The full url to the repository to create the discussion in<br/>**Prerequisites:**<br/>&nbsp;&nbsp;1. Discussions are enabled<br/>&nbsp;&nbsp;2. The app is installed on the repo | **Conditional**: Required if no `team` is provided | `https://github.com/philip-gai/announcement-drafter-demo` |
111112
| `team` | The full url to the team to create the discussion in<br/>**Prerequisites:**<br/>&nbsp;&nbsp;1. The app is installed on the team organization | **Conditional**: Required if no `repository` is provided | `https://github.com/orgs/elastico-group/teams/everyone` |
112113
| `category` | The name of the discussion category | **Conditional**: Required if `repository` is provided | `announcements` |
113-
| Discussion Title | The title of your discussion should be the first top-level header (i.e. `# Discussion Title`) | Yes | See [Example](#example) |
114-
| Discussion Body | The body of your discussion is everything after the top-level header | Yes | See [Example](#example) |
114+
| Discussion Title | The title of your discussion should be the first top-level header (i.e. `# Discussion Title`) | Yes | See [Example](#examples) |
115+
| Discussion Body | The body of your discussion is everything after the top-level header | Yes | See [Example](#examples) |
115116

116117
### Workflow for reviewing and posting a new discussion
117118

118-
1. Write your discussion post with with `announcement-drafter` [discussion markdown](#discussion-markdown)
119+
1. Write your discussion post as usual, adding a special [header with metadata](#discussion-markdown)
119120
1. Create a pull request
120-
1. `announcement-drafter` will comment on the discussion markdown file asking for approval from the pull request author to post the discussions. It will also notify you of any validation erros.
121-
1. If there are errors, just fix them and push to the pull request branch and `announcement-drafter` will revalidate
121+
1. `announcement-drafter` will comment on the file asking for approval from the pull request author to post the discussion
122+
1. If there are errors, just fix them and push to the pull request branch and `announcement-drafter` will [automatically revalidate](https://github.com/philip-gai/announcement-drafter/discussions/75)
122123
1. Receive feedback from your teammates
123-
1. Make updates
124-
1. Approve all the discussions you would like posted by reacting (not replying) with a 🚀
124+
1. Push updates
125125
1. If `announcement-drafter` bot asks, make sure to authenticate so it can post as the author and not as itself
126+
1. Approve the discussion to be created by reacting (not replying) with a 🚀
126127
1. Merge the pull request
127-
1. `announcement-drafter` will create the discussion and reply to the comment with a link to the newly created discussion
128+
1. `announcement-drafter` will create the discussion
129+
1. `announcement-drafter` will reply to the comment with a link to the newly created discussion
128130

129131
## Contributing
130132

0 commit comments

Comments
 (0)