💄 Reduce heading levels in documentation

Author: ujibang

css/main.scss

@@ -246,4 +246,8 @@ iframe {
 
 .bg-white {
   background-color: rgb(233, 226, 226);
+}
+
+h6 {
+    margin-bottom: 0.4em;
 }

docs/auditing.adoc

@@ -4,7 +4,7 @@ layout: docs-adoc
 menu: setup
 ---
 
-== Opentracing / zipkin headers support
+=== Opentracing / zipkin headers support
 
 This implements issue link:https://github.com/SoftInstigate/restheart/issues/287[#287]
 
@@ -14,7 +14,7 @@ This implementation makes it possible to correlate logged exceptions (in case th
 
 It handles all headers mentioned in link:https://github.com/openzipkin/b3-propagation[b3-propagation], as well as the uber-trace-id header that is used by Jaeger (see link:https://www.jaegertracing.io/docs/client-libraries/#trace-span-identity[trace-span-identity] to get broader support.
 
-=== Configuration
+==== Configuration
 
 `/mongo/metrics-gathering-level`: metrics gathering for which level? OFF => no gathering, ROOT => gathering at root level, DATABASE => at db level, COLLECTION => at collection level
 WARNING: use requests-log-level level 2 only for development purposes, it logs user credentials (Authorization and Auth-Token headers).

docs/configuration.adoc

@@ -4,7 +4,7 @@ layout: docs-adoc
 menu: setup
 ---
 
-== Update the `admin` password!
+=== Update the `admin` password!
 
 At first startup, RESTHeart initializes the user `admin`, with the default password `secret`. *This user can execute any request*.
 
@@ -17,7 +17,7 @@ $ curl -u admin:secret -X PATCH localhost:8080/users/admin -H "Content-Type: app
 
 Refer to link:/docs/security/user-management/[User Management] for more information on how to create new users, roles and permissions.
 
-== Default configuration
+=== Default configuration
 
 RESTHeart has a link:/docs/default-configuration[default configuration] and specifying a configuration file is not required.
 
@@ -31,7 +31,7 @@ The following command prints the default configuration to the console.
 [source,bash]
 $ java -jar restheart.jar -t
 
-== Configuration file
+=== Configuration file
 
 RESTHeart can also use a configuration file:
 
@@ -41,7 +41,7 @@ $ java -jar restheart.jar restheart.yml
 
 NOTE: The default configuration is fine most of the times. You just want to change few options and the suggested way is using the default configuration with the needed overrides.
 
-== Modify the configuration with the RHO env var
+=== Modify the configuration with the RHO env var
 
 The environment variable `RHO` allows to modify and add any configuration option.
 
@@ -89,7 +89,7 @@ The following are invalid:
 /mongo/mongo-mounts[1] -> {"where: "/api"    # invalid JSON object
 core/io-threads -> 8                         # xpath expression does not start with /
 
-== Modify the configuration with an override file
+=== Modify the configuration with an override file
 
 A configuration override file can be specified with the `-o` option to modify the default configuration.
 
@@ -143,11 +143,11 @@ YML format, with keys as xpath expressions to select the options to override or
   port: 8080
 ----
 
-== Change the configuration in Docker container
+=== Change the configuration in Docker container
 
 The configuration of RESTHeart running in a Docker container can be modified in three ways.
 
-=== 1 - Using the `RHO` env variable
+==== 1 - Using the `RHO` env variable
 
 The following example uses the option `-e RHO="..."` to override the configuration parameters `/mclient/connection-string` and `/core/name`.
 
@@ -170,7 +170,7 @@ ENV RHO='/mclient/connection-string->"mongodb://host.docker.internal";/http-list
 
 When defining your `RHO` variable always set `/http-listener/host->"0.0.0.0"` and your `/mclient/connection-string`.
 
-=== 2 - Using a configuration override file
+==== 2 - Using a configuration override file
 
 [source,bash]
 $ docker run --rm  -p "8080:8080" -e RHO="" -v /path/to/conf-overrides.conf:/opt/restheart/etc/conf-overrides.conf softinstigate/restheart -o etc/conf-overrides.conf
@@ -185,7 +185,7 @@ ENV RHO='/mclient/connection-string->"mongodb://host.docker.internal";/http-list
 
 To avoid this, just can add `-e RHO=""` to your `docker run` command.
 
-=== 3 - Using a configuration file
+==== 3 - Using a configuration file
 
 The following commands add a configuration file to the container:
 

docs/default-configuration.adoc

@@ -4,7 +4,7 @@ layout: docs-adoc
 menu: setup
 ---
 
-== Introduction
+=== Introduction
 
 This page presents the RESTHeart _default configuration_ splitting it in different sections.
 
@@ -24,7 +24,7 @@ $ java -jar restheart.jar -t
 
 NOTE: The default configuration is fine most of the times. You just want to change few options and the suggested way is using the default configuration with the needed overrides. See link:http://127.0.0.1:4000/docs/configuration#modify-the-configuration-with-the-rho-env-var[modify the configuration with overrides]
 
-== Standalone configuration
+=== Standalone configuration
 
 The default configuration enables several plugins that require MongoDB. If you are using RESTHeart without MongoDB an alternative default configuration can be used with the `-s` option, where `s` stands for _standalone_.
 
@@ -37,7 +37,7 @@ It defines the user `admin` but the password must be set overriding the configur
 $ RHO="/fileRealmAuthenticator/users[userid='admin']/password->'secret'" java -jar core/target/restheart.jar -s
 ----
 
-== Listeners
+=== Listeners
 
 [source,yml]
 ----
@@ -70,7 +70,7 @@ ajp-listener:
   port: 8009
 ----
 
-== Authentication Mechanisms
+=== Authentication Mechanisms
 
 [source,yml]
 ----
@@ -197,7 +197,7 @@ authCookieRemover:
   defaultUri: /logout     # The endpoint that triggers this service.
 ----
 
-== Authorizers
+=== Authorizers
 
 [source,yml]
 ----
@@ -244,7 +244,7 @@ fullAuthorizer:
   authentication-required: true
 ----
 
-== Token Managers
+=== Token Managers
 
 [source,yml]
 ----
@@ -279,7 +279,7 @@ jwtTokenManager:
     # - /nested/property # xpath expr for nested properties
 ----
 
-== Mongo Client Provider
+=== Mongo Client Provider
 
 [source,yml]
 ----
@@ -289,7 +289,7 @@ mclient:
   connection-string: mongodb://127.0.0.1
 ----
 
-== MongoService: MongoDB REST and Websocket API
+=== MongoService: MongoDB REST and Websocket API
 
 [source,yml]
 ----
@@ -388,7 +388,7 @@ mongo:
   aggregation-time-limit: 0
 ----
 
-== MongoDB GraphQL Service
+=== MongoDB GraphQL Service
 
 [source,yml]
 ----
@@ -413,7 +413,7 @@ graphql:
 
 NOTE: `app-cache-enabled` and `app-cache-ttr` are available from v8.0.9 and v8.0.11, respectively. Earlier versions use an expiring cache policy with TTL configurable via the now-deprecated `graphql/app-def-cache-ttl` option. See link:https://github.com/SoftInstigate/restheart/issues/523[issue #523].
 
-== Proxied resources
+=== Proxied resources
 
 [source,yml]
 ----
@@ -435,7 +435,7 @@ proxies:
 #     name: anything
 ----
 
-== Static Web Resources
+=== Static Web Resources
 
 [source,yml]
 ----
@@ -448,7 +448,7 @@ static-resources:
 #    embedded: false
 ----
 
-== Other services
+=== Other services
 
 [source,yml]
 ----
@@ -498,7 +498,7 @@ dateHeader:
   enabled: true
 ----
 
-== Logging
+=== Logging
 
 [source,yml]
 ----
@@ -534,7 +534,7 @@ logging:
   #  - tracestate        # ^^
 ----
 
-== Metrics
+=== Metrics
 
 [source,yml]
 ----
@@ -551,7 +551,7 @@ requestsMetricsCollector:
 jvmMetricsCollector:
   enabled: false
 ----
-== Core module configuration
+=== Core module configuration
 
 [source,yml]
 ----
@@ -611,7 +611,7 @@ core:
   allow-unescaped-characters-in-url: true
 ----
 
-== Connection options
+=== Connection options
 
 [source,yml]
 ----

docs/example-webapps.adoc

@@ -5,15 +5,15 @@ menu: overview
 ---
 :page-liquid:
 
-== Introduction
+=== Introduction
 
 In this section, we'll introduce you to two web applications developed using Angular and RESTHeart, showcasing the capabilities of RESTHeart for Web Applications development.
 
 NOTE: here we use Angular. Of course you can use RESTHeart with any frontend framework!
 
 These examples demonstrate the versatility and ease of use of RESTHeart, which can be seamlessly integrated with various frontend frameworks to build dynamic web applications. Whether you are using Angular, React, or any other framework, RESTHeart provides a robust backend solution for your web development needs.
 
-== Webchat
+=== Webchat
 
 The Webchat application is a real-time chat app hosted at link:https://chat.restheart.org[chat.restheart.org^]. It enables users to engage in real-time conversations with others. What's remarkable about this application is that it requires zero lines of code for creating a real-time chat API, thanks to RESTHeart.
 
@@ -32,7 +32,7 @@ To gain insights into the communication flow between the web clients and RESTHea
 [.img-fluid]
 image::/images/webchat-diagram.gif[Webchat Communication Diagram]
 
-== Messages Table View
+=== Messages Table View
 
 The Messages Table View application offers a simple and intuitive way to display a tabular view of _message_ documents stored in a MongoDB collection. Additionally, it provides a user-friendly form to create new messages. This application is hosted at link:https://ng-demo.restheart.org[ng-demo.restheart.org^].
 
@@ -78,7 +78,7 @@ export class Service {
 }
 ----
 
-== Sending a Message Using cURL
+=== Sending a Message Using cURL
 
 In this section, we'll demonstrate how to send a chat message using the API with `curl`. By sending a POST request to link:https://demo.restheart.org/messages[demo.restheart.org/messages^], you can interact with the chat application programmatically.
 

docs/faq.adoc

@@ -4,7 +4,7 @@ layout: docs-adoc
 menu: overview
 ---
 
-=== What is RESTHeart?
+==== What is RESTHeart?
 
 RESTHeart is a framework for building HTTP microservices that aims to empower developers with intuitive APIs out of the box. It is built for developers, with a focus on simplicity, speed and ease of use.
 
@@ -14,21 +14,21 @@ It has a modular architecture where core functionality is provided by restheart-
 
 '''
 
-=== In which programming language is RESTHeart written?
+==== In which programming language is RESTHeart written?
 
 RESTHeart is primarily written in Java. Thanks to GraalVM, its SDK extends support to Java, Kotlin, JavaScript, and TypeScript. Implementing Hello World examples in any of these languages is straightforward.
 
 Furthermore, RESTHeart is available and can be built with custom plugins as a binary executable, allowing for additional flexibility.
 
 '''
 
-=== What are Virtual Threads
+==== What are Virtual Threads
 
 RESTHeart is the first framework to fully embrace the use of virtual threads, a groundbreaking feature introduced in Java 21. By leveraging virtual threads, RESTHeart achieves remarkable improvements in performance and efficiency. This innovative model makes RESTHeart faster, more lightweight, and simplifies the development of concurrent code. Virtual threads allow for better resource utilization and significantly reduce the complexity associated with concurrent programming, ensuring that RESTHeart remains at the forefront of high-performance, scalable frameworks.
 
 '''
 
-=== Is it Open Source?
+==== Is it Open Source?
 
 Absolutely! RESTHeart is released under the AGPL Open Source License, along with an Enterprise License.
 
@@ -38,25 +38,25 @@ The Enterprise License is specifically designed for organizations seeking extra
 
 '''
 
-=== How does it support MongoDB?
+==== How does it support MongoDB?
 
 The MongoDB plugin exposes the full database capabilities through REST, GraphQL and Websockets with no backend code required. This cuts development time significantly.
 
 '''
 
-=== What security features are supported?
+==== What security features are supported?
 
 RESTHeart offers comprehensive authentication and authorization services, supporting various security schemes. It enables the management of users and permissions directly in MongoDB collections, eliminating the need for backend code. This streamlined approach significantly reduces development time.
 
 '''
 
-=== Why restheart is classified as a low code framework?
+==== Why restheart is classified as a low code framework?
 
 RESTHeart is classified as a low-code framework because it offers developers customizable APIs that are ready to go. It aims to empower developers with an intuitive framework that encompasses essential features, allowing them to build applications without the need to reinvent the wheel. RESTHeart provides pre-configured APIs that cover a broad range of functionality and are highly customizable to fit specific application needs. This approach reduces the amount of code developers need to write, streamlining the development process and making it easier and faster to build cloud-native HTTP microservices.
 
 '''
 
-=== How can I extend the API?
+==== How can I extend the API?
 
 A plugin is a software component that extends the functionality of RESTHeart, allowing you to add additional features and capabilities to the basic API. RESTHeart supports the development of plugins in Java, Kotlin, and JavaScript.
 
@@ -72,7 +72,7 @@ Please note that for JavaScript plugins, you need to run RESTHeart on GraalVM or
 
 '''
 
-=== What categories of plugins are available?
+==== What categories of plugins are available?
 
 There are four types of plugins in RESTHeart:
 
@@ -85,15 +85,15 @@ Additionally, it is also possible to develop security plugins to customize the s
 
 '''
 
-=== What about performances?
+==== What about performances?
 
 In RESTHeart performance is a priority with support for huge throughput, horizontal scaling, and GraalVM for better performance in containers.
 
 It is designed for microservices deployment in Docker/Kubernetes and can run as a standalone JAR, native binary or Docker image.
 
 '''
 
-=== Does the SDK provide a Dependency Injection feature?
+==== Does the SDK provide a Dependency Injection feature?
 
 Yes! Dependency injection in RESTHeart works by using the `@Inject` and `@OnInit` annotations in conjunction with provider classes.