Skip to content

Commit 3c96fed

Browse files
committed
Improve documentation a bit
1 parent 8651e1e commit 3c96fed

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

docs/modules/ROOT/pages/create-github-app.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ QUARKUS_GITHUB_APP_PRIVATE_KEY=-----BEGIN RSA PRIVATE KEY-----\
8181
QUARKUS_GITHUB_APP_APP_ID:: The numeric app id appearing in the `App ID` field.
8282
QUARKUS_GITHUB_APP_APP_NAME:: The name of your app is the one appearing in the GitHub URL.
8383
It is only used to improve usability in dev mode.
84-
QUARKUS_GITHUB_APP_WEBHOOK_PROXY_URL:: The URL you obtained when you created your Smee.io channel.
84+
QUARKUS_GITHUB_APP_WEBHOOK_PROXY_URL:: The URL you obtained when you created your Smee.io channel. If you are using services like https://ngrok.com/[ngrok], you don't need to set it.
8585
QUARKUS_GITHUB_APP_WEBHOOK_SECRET:: The webhook secret you created at the previous step.
8686
QUARKUS_GITHUB_APP_PRIVATE_KEY:: The content of the private key you generated and downloaded.
8787
Open the key file with a text editor as key viewers usually only show fingerprints.
@@ -115,7 +115,7 @@ Check the instructions above carefully.
115115

116116
== Time to code
117117

118-
From now on, you are done with the setup and you can code your GitHub App.
118+
That's it! You are done with the setup and you can code your GitHub App.
119119
Sky is the limit.
120120

121121
For instance, you can create the following class:
@@ -130,7 +130,7 @@ class CreateComment {
130130
}
131131
----
132132

133-
From now on, every time you create an issue in your GitHub project, a comment will be added by your GitHub App.
133+
Every time you create an issue in your GitHub project, a comment will be posted by your GitHub App.
134134

135135
In details:
136136

@@ -143,7 +143,7 @@ In details:
143143

144144
You are done developing your first Quarkus GitHub App.
145145

146-
Obviously the one we developed is not very useful, but it is a good start and using this framework:
146+
Obviously the one we developed is not very useful, but it is a good start and by using this framework:
147147

148148
* You can listen to all the events currently supported by the https://github.com/hub4j/github-api[Hub4j GitHub API].
149149
* You have the full power of Quarkus with live coding, easy configuration, dependency injection, native executables and more.

docs/modules/ROOT/pages/register-github-app.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,15 @@ Keep it around, we will need it later.
6262

6363
[TIP]
6464
====
65-
For now, you don't need to set up a webhook secret:
66-
secret signature checking is disabled when using Smee.io as it modifies the original payload.
65+
No need to start a Smee.io client:
66+
Quarkus GitHub App connects to Smee.io automatically when a webhook proxy url is defined in your configuration.
6767
====
6868

69-
[TIP]
69+
[NOTE]
7070
====
71-
No need to start a Smee.io client:
72-
Quarkus GitHub App connects to Smee.io automatically when a webhook proxy url is defined in your configuration.
71+
You can also use services like https://ngrok.com/[ngrok].
72+
73+
If you do, make sure you use a named domain.
7374
====
7475

7576
=== Webhook secret

0 commit comments

Comments
 (0)