Merge pull request #679 from gsmet/improve-doc

Improve documentation a bit
quarkiverse · Oct 25, 2024 · 0105101 · 0105101
2 parents 43bf121 + 3c96fed
commit 0105101
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 10 deletions.
diff --git a/docs/modules/ROOT/pages/create-github-app.adoc b/docs/modules/ROOT/pages/create-github-app.adoc
@@ -81,7 +81,7 @@ QUARKUS_GITHUB_APP_PRIVATE_KEY=-----BEGIN RSA PRIVATE KEY-----\
 QUARKUS_GITHUB_APP_APP_ID:: The numeric app id appearing in the `App ID` field.
 QUARKUS_GITHUB_APP_APP_NAME:: The name of your app is the one appearing in the GitHub URL.
 It is only used to improve usability in dev mode.
-QUARKUS_GITHUB_APP_WEBHOOK_PROXY_URL:: The URL you obtained when you created your Smee.io channel.
+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.
 QUARKUS_GITHUB_APP_WEBHOOK_SECRET:: The webhook secret you created at the previous step.
 QUARKUS_GITHUB_APP_PRIVATE_KEY:: The content of the private key you generated and downloaded.
 Open the key file with a text editor as key viewers usually only show fingerprints.
@@ -115,7 +115,7 @@ Check the instructions above carefully.
 
 == Time to code
 
-From now on, you are done with the setup and you can code your GitHub App.
+That's it! You are done with the setup and you can code your GitHub App.
 Sky is the limit.
 
 For instance, you can create the following class:
@@ -130,7 +130,7 @@ class CreateComment {
 }
 ----
 
-From now on, every time you create an issue in your GitHub project, a comment will be added by your GitHub App.
+Every time you create an issue in your GitHub project, a comment will be posted by your GitHub App.
 
 In details:
 
@@ -143,7 +143,7 @@ In details:
 
 You are done developing your first Quarkus GitHub App.
 
-Obviously the one we developed is not very useful, but it is a good start and using this framework:
+Obviously the one we developed is not very useful, but it is a good start and by using this framework:
 
 * You can listen to all the events currently supported by the https://github.com/hub4j/github-api[Hub4j GitHub API].
 * You have the full power of Quarkus with live coding, easy configuration, dependency injection, native executables and more.

diff --git a/docs/modules/ROOT/pages/includes/attributes.adoc b/docs/modules/ROOT/pages/includes/attributes.adoc
@@ -1,4 +1,4 @@
-:quarkus-version: 3.13.3
+:quarkus-version: 3.16.0
 :quarkus-github-app-version: 2.7.0
 
 :github-api-javadoc-root-url: https://github-api.kohsuke.org/apidocs/org/kohsuke/github

diff --git a/docs/modules/ROOT/pages/register-github-app.adoc b/docs/modules/ROOT/pages/register-github-app.adoc
@@ -62,14 +62,15 @@ Keep it around, we will need it later.
 
 [TIP]
 ====
-For now, you don't need to set up a webhook secret:
-secret signature checking is disabled when using Smee.io as it modifies the original payload.
+No need to start a Smee.io client:
+Quarkus GitHub App connects to Smee.io automatically when a webhook proxy url is defined in your configuration.
 ====
 
-[TIP]
+[NOTE]
 ====
-No need to start a Smee.io client:
-Quarkus GitHub App connects to Smee.io automatically when a webhook proxy url is defined in your configuration.
+You can also use services like https://ngrok.com/[ngrok].
+
+If you do, make sure you use a named domain.
 ====
 
 === Webhook secret