[APPENG-299] Updates docs as per TechDocs guidelines (#20)

transferwise · Feb 27, 2023 · 2909280 · 2909280
1 parent 05fda48
commit 2909280
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -5,15 +5,9 @@
 [![Owners](https://img.shields.io/badge/team-AppEng-blueviolet.svg?logo=wise)](https://transferwise.atlassian.net/wiki/spaces/EKB/pages/2520812116/Application+Engineering+Team) [![Slack](https://img.shields.io/badge/slack-sre--guild-blue.svg?logo=slack)](https://app.slack.com/client/T026FB76G/CLR1U8SNS)
 > Use the `@application-engineering-on-call` handle on Slack for help.
 ---
-The library will create a Curator Auto Configuration, which will provide a CuratorFramework bean.
 
-It is necessary to reduce duplication in most of our libraries.
-
-## Configuration
-
-Usually you just need to specify `tw-curator.zookeeper-connect-string`.
-
-Consult with `TwCuratorProperties` for options.
+## 📚 Documentation
+Documentation can be found in the [docs](docs/) directory, or if you're a Wiser, on the [developer portal](https://dev.tw.ee/docs/default/Component/tw-curator).
 
 ## License
 Copyright 2021 TransferWise Ltd.
@@ -28,4 +22,8 @@ Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
-limitations under the License.
+limitations under the License.
+
+
+
+
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -0,0 +1,5 @@
+# Configuration
+
+Usually you just need to specify `tw-curator.zookeeper-connect-string`.
+
+Consult with `TwCuratorProperties` for options.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1,3 @@
+# Contribution Guide
+To contribute to the library, you can either open an issue or create a pull request. Please ensure that you create unit tests for any new features you introduce and ensure that all tests are passing.
+Finally, please remember to update the [project's version](https://github.com/transferwise/tw-curator/blob/master/gradle.properties) following [semantic versioning](https://semver.org/), and update the [CHANGELOG](https://github.com/transferwise/tw-curator/blob/master/CHANGELOG.md) accordingly.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,14 @@
+# Tw-Curator documentation
+
+## Table of Contents
+* [Introduction](#intro)
+* [Configuration](configuration.md)
+* [Usage](usage.md)
+* [Contribution Guide](contributing.md)
+
+## Intro
+
+The library will create a Curator Auto Configuration, which will provide a CuratorFramework bean.
+
+It is necessary to reduce duplication in most of our libraries.
+
diff --git a/docs/usage.md b/docs/usage.md
@@ -0,0 +1,15 @@
+# Usage
+
+To use the library, first add the `mavenCentral` repository to your `repositories` block in your `build.gradle`:
+```groovy
+repositories {
+  mavenCentral()
+}
+```
+Then, add the `tw-curator` library as a dependency in your `dependencies` block in your `build.gradle`:
+```groovy
+dependencies {
+  implementation 'com.transferwise.common:tw-curator:<VERSION>'
+}
+```
+> Replace `<VERSION>` with the version of the library you want to use.
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -0,0 +1,8 @@
+site_name: Tw-Curator Documentation
+repo_url: https://github.com/transferwise/tw-curator
+edit_uri: blob/master/docs/
+nav:
+  - Overview: index.md
+  - Configuration: configuration.md
+  - Usage: usage.md
+  - Contributing: contributing.md