diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 96cd900b..f1b1b21c 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,4 +1,4 @@ # Users referenced in this file will automatically be requested as reviewers for PRs that modify the given paths. # See https://help.github.com/articles/about-code-owners/ -* @Simply007 +* @Simply007 @kontent-ai/developer-relations diff --git a/README.md b/README.md index 7e03c8cd..d4fe1e80 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ Monorepo with Java Kontent.ai packages. | [Kontent.ai Sample Gradle Console app](/test-gradle-console-app#readme) | Simple Java console application showcasing how to load data from Kontent.ai. | [source](/test-gradle-console-app/README.md) | | [Kontent.ai Sample Android app (Java)](/sample-app-android#readme) | Showcase of the [Android](https://www.android.com/) application written in Java using [RxJava](https://github.com/ReactiveX/RxJava) for data fetching from Kontent.ai. | [source](/sample-app-android/README.md) | | [Kontent.ai Sample Android app (Kotlin)](/sample-app-android-kotlin#readme) | Showcase of the [Android](https://www.android.com/) application written in Kotlin using [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) for data fetching from Kontent.ai. | [source](/sample-app-android-kotlin/README.md) | +| [Kontent.ai Java packages docs](/docs#readme) | Documentation for Kontent.ai Java packages |[source](/docs/README.md)| ## Development @@ -27,7 +28,6 @@ If you wish to find out more about the project specification. Check out the [Pro - Java 8 SDK (Oracle & OpenJDK both tested and supported) - [Android SDK](https://developer.android.com/studio#downloads) for the sample application (minimal version 28) - command line tools would be sufficient - ### Build and Test - Ensure your `JAVA_HOME` environment is set. diff --git a/delivery-sdk/README.md b/delivery-sdk/README.md index 1ef3ed01..fa81628c 100644 --- a/delivery-sdk/README.md +++ b/delivery-sdk/README.md @@ -47,7 +47,6 @@ dependencies { The `DeliveryClient` class is the main class of the SDK. Using this class, you can retrieve content from your Kontent.ai projects. - To create an instance of the class, you need to provide a [project ID](https://kontent.ai/learn/tutorials/develop-apps/get-content/getting-content#a-getting-content-items). ```java @@ -87,7 +86,6 @@ Once you create a `DeliveryClient`, you can start querying your project reposito To retrieve unpublished content, you need to create a `DeliveryClient` with both Project ID and Preview API key (You could also configure Preview API key in `DeliveryOptions` described above). Each Kontent.ai project has its own Preview API key. - ```java // Note: Within a single project, we recommend that you work with only // either the production or preview Delivery API, not both. @@ -150,7 +148,7 @@ CompletionsStage response = client.getItems( .includeTotalCount() .build() ) -``` +``` ## Response structure @@ -250,7 +248,7 @@ for (Option option : element.getOptions()) { item.setValue(option.getCodename()); item.setSelected("semi_dry".equals(option.getCodename())); } -``` +``` ### Linked items @@ -270,8 +268,8 @@ String customElementValue = ((CustomElement) articleItem.getElements().get("colo To use this SDK for [Android](https://developer.android.com/) development, you can use any approach compatible with [Java CompletionStage API](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletionStage.html). Most common is to use [Kotlin coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) for Android applications written in Kotlin and [Java RX](https://github.com/ReactiveX/RxJava) for Android applications written in Java. Both of these approaches are showcased in this repository: -* [Android Java sample application](../sample-app-android#readme) -* [Android Kotlin Java Sample application](../sample-app-android-kotlin#readme) +- [Android Java sample application](../sample-app-android#readme) +- [Android Kotlin Java Sample application](../sample-app-android-kotlin#readme) ⚠ There are two Android-specific rules you need to follow in order for the Delivery SDK to work correctly. @@ -298,6 +296,8 @@ You can still use the [model generator](../delivery-sdk-generators/README.md) fo ## Further information +To see more detailed information, check out the [Kontent.ai Java packages documentation section](/docs/README.md). + For more developer resources, visit the [Kontent.ai Learn portal](https://kontent.ai/learn). ### Showcase