Merge pull request #512 from commercetools/overview-toc

commercetools · Oct 25, 2023 · 0733158 · 0733158
2 parents 37923aa + 73f3f7c
commit 0733158
Show file tree

Hide file tree

Showing 4 changed files with 87 additions and 31 deletions.
diff --git a/build.gradle b/build.gradle
@@ -68,7 +68,7 @@ allprojects {
     }
 
     dependencies {
-        taglet 'com.commercetools.build.taglets:commercetools-taglets:3.6.2'
+        taglet 'com.commercetools.build.taglets:commercetools-taglets:3.6.3'
         taglet 'org.jdrupes.taglets:plantuml-taglet:2.1.0'
     }
 }

diff --git a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/GraphQL.java b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/GraphQL.java
@@ -14,7 +14,7 @@
  *
  * {@include.example example.GraphQLTest#graphqlMapToClass(com.commercetools.api.models.product.Product)}
  *
- * <h2 id=graphql-module>GraphQL module</h2>
+ * <h3 id=graphql-module>GraphQL module</h3>
  *
  * <p>The SDK comes with a module for enhanced GraphQL support. With the help of the <a href="https://netflix.github.io/dgs/generating-code-from-schema/">DGS codegen</a>
  * we generate a type safe query and projection builder. The results will be mapped to the correct response type.</p>

diff --git a/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Logging.java b/commercetools/internal-docs/src/main/java/com/commercetools/docs/meta/Logging.java
@@ -13,7 +13,7 @@
  *
  * <p>Internal logging used by the commercetools Composable Commerce client itself. Uses slf4j logger named {@code commercetools}.</p>
  *
- * <h2 id=logger-configuration>Logger configuration</h2>
+ * <h3 id=logger-configuration>Logger configuration</h3>
  *
  * <p>The {@link io.vrap.rmf.base.client.ClientBuilder} allows the customization of the log levels used for different events. By default responses
  * will be logged with {@link org.slf4j.event.Level#INFO} and errors with {@link org.slf4j.event.Level#ERROR}. The
@@ -22,33 +22,33 @@
  *
  * {@include.example example.ExamplesTest#loggingConfiguration}
  *
- * <h2 id=log-information>Log Information</h2>
+ * <h3 id=log-information>Log Information</h3>
  *
  * The default logger middleware logs following information per level:
  *
- * <h3>Error</h3>
+ * <h4>Error</h4>
  *
  * In case of an {@link io.vrap.rmf.base.client.ApiHttpException} the requests HTTP method name, URI and response status code
  * will be logged. For any other exception happening the cause and the exception will be logged.
  *
- * <h3>Info</h3>
+ * <h4>Info</h4>
  *
  * <p>By default any response by the API will be logged with the requests HTTP method name, URI and response status code.
  * In case a deprecation header was submitted in the response an info entry with the deprecation notice will be logged.</p>
  *
  * <p>The used log level for these events can be configured while instantiating the InternalLoggerMiddleware.</p>
  *
- * <h3>Debug</h3>
+ * <h4>Debug</h4>
  *
  * <p>The request and the response object will be logged as a string representation including headers and body. Sensitive
  * data like auth token and passwords will be redacted.</p>
  *
- * <h3>Trace</h3>
+ * <h4>Trace</h4>
  *
  * </p>The request and response will be logged with a pretty printed output.  Sensitive data like auth token and passwords
  * will be redacted.</p>
  *
- * <h2 id=logger-hierarchy>Logger hierarchy</h2>
+ * <h3 id=logger-hierarchy>Logger hierarchy</h3>
  *
  * <p>The loggers form a hierarchy separated by a dot. The root logger is {@code commercetools}.</p>
  *
@@ -116,7 +116,7 @@
  * [pool-1-thread-1] DEBUG commercetools.products.request.queries - io.vrap.rmf.base.client.ApiHttpRequest@53667fdb[method=GET,uri="https://api.europe-west1.gcp.commercetools.com/test-php-dev-integration-1/products/ef745227-b115-4132-ba2c-4e46db80df79",headers=[...],textInterpretedBody=empty body]
  * }</pre>
  *
- * <h2 id=mdc_usage>Usage of Mapped Diagnostic Context</h2>
+ * <h3 id=mdc_usage>Usage of Mapped Diagnostic Context</h3>
  *
  * <p>The SDK uses {@link java.util.concurrent.CompletableFuture CompletableFutures} extensively and the {@link java.util.concurrent.ExecutorService} typically has a thread pool
  * to execute the futures. This could lead to the fact that the future is executed on different threads. In case the {@link org.slf4j.MDC} is used by the application the context

diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
@@ -5,8 +5,14 @@ <h1 class="toc-ignore">Pages about the SDK</h1>
 
         <h2>First steps</h2>
         <ol>
-            <li>{@link com.commercetools.docs.meta.Installation Installation}</li>
-            <li>{@link com.commercetools.docs.meta.GettingStarted Getting Started}</li>
+            <li>
+                {@link com.commercetools.docs.meta.Installation Installation}
+                {@include.toc com.commercetools.docs.meta.Installation}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.GettingStarted Getting Started}
+                {@include.toc com.commercetools.docs.meta.GettingStarted}
+            </li>
             <li>
                 {@link com.commercetools.docs.meta.Endpoints Supported Endpoints}
                 <ul>
@@ -18,44 +24,94 @@ <h2>First steps</h2>
             </li>
             <li>
                 {@link com.commercetools.docs.meta.Configuration Configuration}
-                <ul>
-                    <li>{@link com.commercetools.docs.meta.Authentication Authentication}</li>
-                </ul>
+                {@include.toc com.commercetools.docs.meta.Configuration}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.Authentication Authentication}
+                {@include.toc com.commercetools.docs.meta.Authentication}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.Querying Querying}
+                {@include.toc com.commercetools.docs.meta.Querying}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.Middlewares Middlewares}
+                {@include.toc com.commercetools.docs.meta.Middlewares}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.GraphQL GraphQL}
+                {@include.toc com.commercetools.docs.meta.GraphQL}
             </li>
-            <li>{@link com.commercetools.docs.meta.Querying Querying}</li>
-            <li>{@link com.commercetools.docs.meta.Middlewares Middlewares}</li>
-            <li>{@link com.commercetools.docs.meta.GraphQL GraphQL}</li>
         </ol>
         <h2>Products and ProductTypes</h2>
         <ol>
-            <li>{@link com.commercetools.docs.meta.ProductAttributeDocumentation Product attributes}</li>
+            <li>
+                {@link com.commercetools.docs.meta.ProductAttributeDocumentation Product attributes}
+                {@include.toc com.commercetools.docs.meta.ProductAttributeDocumentation}
+            </li>
         </ol>
         <h2>Preparing for the worst</h2>
         <ol>
-            <li>{@link com.commercetools.docs.meta.ExceptionDocumentation Exception documentation}</li>
-            <li>{@link com.commercetools.docs.meta.Logging Logging}</li>
+            <li>
+                {@link com.commercetools.docs.meta.ExceptionDocumentation Exception documentation}
+                {@include.toc com.commercetools.docs.meta.ExceptionDocumentation}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.Logging Logging}
+                {@include.toc com.commercetools.docs.meta.Logging}
+            </li>
         </ol>
         <h2>Customization</h2>
         <ol>
-            <li>{@link com.commercetools.docs.meta.Serialization Serialization}</li>
-            <li>{@link com.commercetools.docs.meta.ClientTuning Client Tuning}</li>
+            <li>
+                {@link com.commercetools.docs.meta.Serialization Serialization}
+                {@include.toc com.commercetools.docs.meta.Serialization}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.ClientTuning Client Tuning}
+                {@include.toc com.commercetools.docs.meta.ClientTuning}
+            </li>
         </ol>
         <h2>Other</h2>
         <ol>
-            <li>{@link com.commercetools.docs.meta.GeneralConcept General concepts}</li>
-            <li>{@link com.commercetools.docs.meta.DataRepresentation Data representation}</li>
-            <li>{@link com.commercetools.docs.meta.Features Features}</li>
-            <li>{@link com.commercetools.docs.meta.Using Using}</li>
+            <li>
+                {@link com.commercetools.docs.meta.GeneralConcept General concepts}
+                {@include.toc com.commercetools.docs.meta.GeneralConcept}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.DataRepresentation Data representation}
+                {@include.toc com.commercetools.docs.meta.DataRepresentation}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.Features Features}
+                {@include.toc com.commercetools.docs.meta.Features}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.Using Using}
+                {@include.toc com.commercetools.docs.meta.Using}
+            </li>
         </ol>
         <h2>Migration from SDK v1</h2>
         <ol>
-            <li>{@link com.commercetools.docs.meta.Migration Overview}</li>
-            <li>{@link com.commercetools.docs.meta.Compatibility Compatibility JVM SDK (v1)}</li>
-            <li>{@link com.commercetools.docs.meta.MigrationModelClassMapping Model class mapping SDK v1 to v2}</li>
+            <li>
+                {@link com.commercetools.docs.meta.Migration Overview}
+                {@include.toc com.commercetools.docs.meta.Migration}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.Compatibility Compatibility JVM SDK (v1)}
+                {@include.toc com.commercetools.docs.meta.Compatibility}
+            </li>
+            <li>
+                {@link com.commercetools.docs.meta.MigrationModelClassMapping Model class mapping SDK v1 to v2}
+                {@include.toc com.commercetools.docs.meta.MigrationModelClassMapping}
+            </li>
         </ol>
         <h2>Monitoring</h2>
         <ol>
-            <li>{@link com.commercetools.monitoring.newrelic.NewRelicTelemetryMiddleware NewRelic}</li>
+            <li>
+                {@link com.commercetools.monitoring.newrelic.NewRelicTelemetryMiddleware NewRelic}
+                {@include.toc com.commercetools.monitoring.newrelic.NewRelicTelemetryMiddleware}
+            </li>
         </ol>
     </div>
 </body>