Docs/spring security (#27)

* GH-3: docs: Add spring-security to FAQ

* docs: Simplify quickstart

* docs: Fix link in FAQ

Author: timonback

docs/faq.md

@@ -16,23 +16,23 @@ Yes, you can use springwolf for private and commercial purposes as long as you c
 
 When the `springwolf-ui` dependency is added, the ui should be visible at [http://localhost:8080/springwolf/asyncapi-ui.html](http://localhost:8080/springwolf/asyncapi-ui.html).
 
-If not, check
-1. the spring `context-path` setting 
-2. if static assets are being served. See the code below:
-```java
-@Configuration
-public class WebConfig implements WebMvcConfigurer {
-
-  @Override
-  public void addResourceHandlers(ResourceHandlerRegistry registry) {
-    registry
-        .addResourceHandler("/**")
-        .addResourceLocations("classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/");
-  }
-}
-```
-
-Taken from [Discord Chat](https://discord.com/channels/950375987475005471/950375988217409548/1051909821848363038)
+If not, whether
+1. you customized the spring `context-path` setting 
+2. static assets are being served at all. See the code below:
+    ```java
+    @Configuration
+    public class WebConfig implements WebMvcConfigurer {
+      @Override
+      public void addResourceHandlers(ResourceHandlerRegistry registry) {
+        registry
+            .addResourceHandler("/**")
+            .addResourceLocations("classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/");
+      }
+    }
+    ```
+
+    Taken from [Discord Chat](https://discord.com/channels/950375987475005471/950375988217409548/1051909821848363038)
+3. spring-security (or similar) denies access the urls (HTTP 403). Check `CustomWebSecurityConfigurerAdapter` in springwolf-kafka-example.
 
 ### Unable to publish message from the UI
 
@@ -92,5 +92,5 @@ This is expected, as there are use-cases where different payloads are sent via t
 
 Springwolf uses on scanners to find all consumer and producers in your application.
 Most likely two scanners found your consumer/producer each.
-See [configuration](configuration/configuration.md) to disable scanners.
+See [configuration](configuration.md) to disable scanners.
 

docs/quickstart.md

@@ -11,7 +11,7 @@ import CodeSpringwolfMaven from '!!raw-loader!./snippets/_springwolf_maven.md';
 
 *The following instructions are for Kafka services - but amqp services configuration is almost identical. Check out the [example project for complete examples](https://github.com/timonback/springwolf-core/tree/master/springwolf-examples).*
 
-## Dependencies
+## 1. Add dependencies
 
 Add the following dependencies:
 
@@ -30,9 +30,9 @@ Latest version:
 - ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-kafka?color=green&label=springwolf-kafka&style=plastic)
 - ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-ui?color=green&label=springwolf-ui&style=plastic)
 
-## Configuration properties
+## 2. Configure properties
 
-Add the following to your application.properties
+Add the following to your application.properties:
 
 ```properties
 springwolf.docket.base-package=io.github.stavshamir.springwolf.example.consumers
@@ -46,8 +46,10 @@ springwolf.docket.servers.kafka.url=${kafka.bootstrap.servers:localhost:29092}
 
 *Make sure to change the value of `springwolf.docket.base-package` to the package containing your listeners, so that springwolf will automatically pick them up.*
 
-## View the docs
-After starting the application, visit `<host>:<port>/springwolf/asyncapi-ui.html` to view the UI or `<host>:<port>/springwolf/docs` to view the raw AsyncAPI document.
+## 3. View the docs
+Start the application and open the urls in your browser:
+- AsyncApi: [`<host>:<port>/springwolf/docs`](http://localhost:8080/springwolf/docs)
+- UI: [`<host>:<port>/springwolf/asyncapi-ui.html`](http://localhost:8080/springwolf/asyncapi-ui.html)
 
 If you configured a different context path in your application, make sure to prepend it to springwolf urls, i.e. `<host>:<port>/<context-path>/springwolf/asyncapi-ui.html`