Skip to content

Commit cad7d23

Browse files
authored
Merge pull request #77 from laminas/fix-readme
Correct indentation on the readme
2 parents fd30188 + 02b0e97 commit cad7d23

File tree

1 file changed

+59
-59
lines changed

1 file changed

+59
-59
lines changed

README.md

Lines changed: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -24,68 +24,68 @@ Laminas Project Bot.
2424
The Laminas Bot acts as:
2525

2626
- A GitHub webhook handler:
27-
- Report new issues and pull requests to the Laminas Slack #github channel.
28-
- Report new issue and pull request commments to the Laminas Slack #github channel.
29-
- Report repository build status to the Laminas Slack #github channel.
30-
- Report releases to:
31-
- The Laminas Slack #github channel.
32-
- The https://getlaminas API, to allow rebuilding the release RSS feed.
27+
- Report new issues and pull requests to the Laminas Slack #github channel.
28+
- Report new issue and pull request commments to the Laminas Slack #github channel.
29+
- Report repository build status to the Laminas Slack #github channel.
30+
- Report releases to:
31+
- The Laminas Slack #github channel.
32+
- The https://getlaminas API, to allow rebuilding the release RSS feed.
3333

3434
- A Discourse webhook handler:
35-
- Report new posts to the category-appropriate channel on the Laminas Slack.
35+
- Report new posts to the category-appropriate channel on the Laminas Slack.
3636

3737
- A Slack slash command handler for the Technical Steering Committee:
38-
- /build-docs to trigger a documentation rebuild for a given repository.
39-
- /register-repo to register the github webhooks for Laminas-BOT with the
40-
given repository.
41-
- /regenerate-tsc-list triggers rebuilding the list of TSC members (the only
42-
ones authorized to initiate slash commands).
38+
- /build-docs to trigger a documentation rebuild for a given repository.
39+
- /register-repo to register the github webhooks for Laminas-BOT with the
40+
given repository.
41+
- /regenerate-tsc-list triggers rebuilding the list of TSC members (the only
42+
ones authorized to initiate slash commands).
4343

4444
### Requirements
4545

4646
- From Slack
47-
- Create a Bot integration
48-
- Add the signing secret to the SLACK_SIGNING_SECRET
49-
- Setup OAuth
50-
- Add the OAuth token value to SLACK_TOKEN
51-
- Set the following scopes
52-
- channels:read
53-
- chat:write
54-
- chat:write.public (to allow writing to any public channel)
55-
- commands
56-
- groups:read
57-
- im:read
58-
- links:read
59-
- links:write
60-
- mpim:read
61-
- Setup Slash commands
62-
- All commands go to https://laminas.dev/api/slack
63-
- /laminas
64-
- /regenerate-tsc-list
65-
- /register-repo {repo}
66-
- /build-docs {repo}
67-
- Setup an incoming webhook
68-
- Add location to SLACK_WEBHOOK_LOGGING
69-
- Invite the bot to #technical-steering-committee and #laminasbot-errors
47+
- Create a Bot integration
48+
- Add the signing secret to the SLACK_SIGNING_SECRET
49+
- Setup OAuth
50+
- Add the OAuth token value to SLACK_TOKEN
51+
- Set the following scopes
52+
- channels:read
53+
- chat:write
54+
- chat:write.public (to allow writing to any public channel)
55+
- commands
56+
- groups:read
57+
- im:read
58+
- links:read
59+
- links:write
60+
- mpim:read
61+
- Setup Slash commands
62+
- All commands go to https://laminas.dev/api/slack
63+
- /laminas
64+
- /regenerate-tsc-list
65+
- /register-repo {repo}
66+
- /build-docs {repo}
67+
- Setup an incoming webhook
68+
- Add location to SLACK_WEBHOOK_LOGGING
69+
- Invite the bot to #technical-steering-committee and #laminasbot-errors
7070

7171
- From GitHub
72-
- We need a valid personal access token with "repo" permissions; add to
73-
GITHUB_TOKEN
74-
- We need a signing secret; this can be arbitrary, but once used, must be used
75-
for ALL repositories when registering the webhook. Add to GITHUB_SECRET
72+
- We need a valid personal access token with "repo" permissions; add to
73+
GITHUB_TOKEN
74+
- We need a signing secret; this can be arbitrary, but once used, must be used
75+
for ALL repositories when registering the webhook. Add to GITHUB_SECRET
7676

7777
- From Discourse
78-
- We need a signing secret; this can be arbitrary, but once used, must be used
79-
when registering ALL webhooks. Add to DISCOURSE_SECRET
78+
- We need a signing secret; this can be arbitrary, but once used, must be used
79+
when registering ALL webhooks. Add to DISCOURSE_SECRET
8080

8181
- From Mastodon
82-
- We need access credentials from a created app as
83-
- MASTODON_CLIENT_ID
84-
- MASTODON_CLIENT_SECRET
85-
- MASTODON_BEARER_TOKEN
82+
- We need access credentials from a created app as
83+
- MASTODON_CLIENT_ID
84+
- MASTODON_CLIENT_SECRET
85+
- MASTODON_BEARER_TOKEN
8686

8787
- From getlaminas
88-
- We need the shared web token, as LAMINAS_API_TOKEN.
88+
- We need the shared web token, as LAMINAS_API_TOKEN.
8989

9090
### Architecture
9191

@@ -153,27 +153,27 @@ API, and the classes providing the support are under the `App\Slack\Domain`
153153
namespace. Implementations include:
154154

155155
- Messages
156-
- General `Message` content (see https://api.slack.com/reference/messaging/payload)
156+
- General `Message` content (see https://api.slack.com/reference/messaging/payload)
157157

158-
- `WebAPIMessage`, for sending messages via the Slack `chat.postMessage`
159-
endpoint (and related endpoints). This is a normal `Message` payload, with
160-
the addition of the Slack channel to which you are posting the message. (See
161-
https://api.slack.com/methods/chat.postMessage#channels)
158+
- `WebAPIMessage`, for sending messages via the Slack `chat.postMessage`
159+
endpoint (and related endpoints). This is a normal `Message` payload, with
160+
the addition of the Slack channel to which you are posting the message. (See
161+
https://api.slack.com/methods/chat.postMessage#channels)
162162

163-
- `SlashResponseMessage`, for sending a message to a Slash command webhook
164-
response URL. This is a normal `Message` payload, with the addition of the
165-
`response_type` (one of "ephemeral" - the default - or "in_channel"). (See
166-
https://api.slack.com/interactivity/handling#responses)
163+
- `SlashResponseMessage`, for sending a message to a Slash command webhook
164+
response URL. This is a normal `Message` payload, with the addition of the
165+
`response_type` (one of "ephemeral" - the default - or "in_channel"). (See
166+
https://api.slack.com/interactivity/handling#responses)
167167

168168
- Blocks
169-
- `ContextBlock` (see https://api.slack.com/reference/block-kit/blocks#context)
170-
- `SectionBlock` (see https://api.slack.com/reference/block-kit/blocks#context)
169+
- `ContextBlock` (see https://api.slack.com/reference/block-kit/blocks#context)
170+
- `SectionBlock` (see https://api.slack.com/reference/block-kit/blocks#context)
171171

172172
- Composition objects
173-
- `TextObject` (see https://api.slack.com/reference/block-kit/composition-objects#text)
173+
- `TextObject` (see https://api.slack.com/reference/block-kit/composition-objects#text)
174174

175175
- Element objects
176-
- `ImageElement` (see https://api.slack.com/reference/block-kit/block-elements#image)
176+
- `ImageElement` (see https://api.slack.com/reference/block-kit/block-elements#image)
177177

178178
All of these objects support:
179179

0 commit comments

Comments
 (0)