DOCSP-41157: Set up initial repo and index page (mongodb#2)

.github/pull_request_template.md

@@ -0,0 +1,14 @@
+# Pull Request Info
+
+[PR Reviewing Guidelines](https://github.com/mongodb/docs-kotlin-sync/blob/master/REVIEWING.md)
+
+JIRA - <https://jira.mongodb.org/browse/DOCSP-NNNNN>
+Staging - <https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/NNNNN/>
+
+## Self-Review Checklist
+
+- [ ] Is this free of any warnings or errors in the RST?
+- [ ] Did you run a spell-check?
+- [ ] Did you run a grammar-check?
+- [ ] Are all the links working?
+- [ ] Are the [facets and meta keywords](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) accurate?

.github/workflows/check-autobuilder.yml

@@ -0,0 +1,13 @@
+name: Check Autobuilder for Errors
+
+on:
+  pull_request:
+    paths:
+      - "source/**"
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: cbush/snooty-autobuilder-check@main

.github/workflows/vale-tdbx.yml

@@ -0,0 +1,39 @@
+name: vale-checks
+on:
+  pull_request:
+    paths:
+      - "source/**"
+
+jobs:
+  vale:
+    name: TDBX Vale rules
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@master
+
+      - id: files
+        uses: masesgroup/retrieve-changed-files@v2
+        with:
+          format: 'csv'
+
+      - name: checkout-latest-rules
+        uses: actions/checkout@master
+        with:
+          repository: mongodb/mongodb-vale-action
+          path: './tdbx-vale-rules'
+          token: ${{secrets.GITHUB_TOKEN}}
+
+      - name: move-files-for-vale-action
+        run: |
+            cp tdbx-vale-rules/.vale.ini .vale.ini
+            mkdir -p .github/styles/
+            cp -rf tdbx-vale-rules/.github/styles/ .github/
+
+      - name: run-vale
+        uses: errata-ai/vale-action@reviewdog
+        with:
+          reporter: github-pr-check
+          files: ${{steps.files.outputs.added_modified}}
+          fail_on_error: true
+          token: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -0,0 +1 @@
+.vscode

README.rst

@@ -0,0 +1,21 @@
+==================================
+{+driver-long+} Documentation
+==================================
+
+This repository contains documentation for the {+driver-short+}.
+
+## File JIRA Tickets
+
+Please file issue reports or requests at the `Documentation Jira Project
+<https://jira.mongodb.org/browse/DOCS>`_.
+
+## Licenses
+
+All documentation is available under the terms of a `Creative Commons
+License <https://creativecommons.org/licenses/by-nc-sa/3.0/>`_.
+
+The MongoDB Documentation Project is governed by the terms of the
+`MongoDB Contributor Agreement
+<https://www.mongodb.com/legal/contributor-agreement>`_.
+
+-- The MongoDB Documentation Team

REVIEWING.md

@@ -0,0 +1,42 @@
+# Pull Request Reviewing Guidelines for Kotlin Sync Driver Documentation
+
+Contributions to the set of documents in this repository can receive reviews from one or both of the following types of reviews:
+
+1. A **copy review**, which focuses on information structure and wording; typically performed by a MongoDB Documentation Team member
+2. A **technical review**, which addresses code snippets and the technical correctness of prose; typically performed by a MongoDB engineer.
+
+See the following sections for reviewer expectations for each type of pull request (PR) review:
+
+## Copy Review
+
+Review the structure, wording, and flow of the information in the PR, and correct it if necessary.
+
+### What to Review
+
+- Wording
+- Page structure
+- Technical content to the extent of the reviewer’s understanding.
+- Whether the PR fulfills the Acceptance Criteria described in the
+  linked JIRA ticket.
+
+### What Not to Review
+
+Nothing is completely off-limits to a copy review of a PR -- if you notice a technical issue, it's best to call it out early.
+Copy reviewers should constrain their reviews to content within the scope of the JIRA ticket, or otherwise create PRs to address anything unrelated.
+
+## Technical Review
+
+Review the technical accuracy and completeness of a PR and correct it if necessary.
+
+### What to Review
+
+- Code snippets; ensure the code is idiomatic and that all technical claims are correct. e.g. ("To create a `Foo`, use the `Bar.createFoo()` method")
+- Problematic explanations that could trip up users who try to follow the documentation.
+
+### What Not to Review
+
+While we welcome any recommendations on wording and structure, avoid blocking approval based on any copy edits. Please entrust the author to make the writing decisions based on style guidelines and team-specific writing conventions, and to create PRs to address anything they deem outside the technical review scope.
+
+- Wording of sentences, although corrections to technical claims are welcome
+- Structure of the page
+- Any unchanged lines outside the PR unless relevant to the ticket acceptance criteria.

snooty.toml

@@ -2,10 +2,19 @@ name = "kotlin-sync"
 title = "Kotlin Sync Driver"
 
 intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
+                "https://www.mongodb.com/docs/drivers/objects.inv",
                 "https://www.mongodb.com/docs/atlas/objects.inv"
               ]
 
-# toc_landing_pages = ["/paths/to/pages/that/have/nested/content"]
+toc_landing_pages = []
 
-# [constants]
-# constant = "value"
+[constants]
+driver-long = "MongoDB Kotlin Sync Driver"
+driver-short = "Kotlin Sync driver"
+language = "Kotlin"
+version-number = "5.1"
+version = "v{+version-number+}"
+patch-version-number = "{+version-number+}.0"
+mdb-server = "MongoDB Server"
+stable-api = "Stable API"
+api = "https://mongodb.github.io/mongo-java-driver/{+version-number+}/apidocs/mongodb-driver-kotlin-sync"

source/compatibility.txt

@@ -0,0 +1,7 @@
+.. _kotlin-sync-compatibility:
+
+=============
+Compatibility
+=============
+
+.. TODO

source/connection-troubleshooting.txt

@@ -0,0 +1,7 @@
+.. _kotlin-sync-connection-troubleshooting:
+
+==========================
+Connection Troubleshooting
+==========================
+
+.. TODO

source/faq.txt

@@ -0,0 +1,7 @@
+.. _kotlin-sync-faq:
+
+===
+FAQ
+===
+
+.. TODO

source/index.txt

@@ -1,10 +1,91 @@
-==================
-Kotlin Sync Driver
-==================
+==========================
+{+driver-long+}
+==========================
 
-.. default-domain:: mongodb
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
 
-Your words here. Don't forget to add a toctree!
+   /faq
+   /connection-troubleshooting
+   /issues-and-help
+   /compatibility
+   View the Source <https://github.com/mongodb/mongo-java-driver/tree/master/driver-kotlin-sync>
 
-Have a lovely day!
+Introduction
+------------
 
+Welcome to the documentation site for the {+driver-long+}, the official
+MongoDB driver for synchronous Kotlin applications. Download the driver by using
+`Maven <https://maven.apache.org/>`__ or `Gradle <https://gradle.org/>`__, or set up a
+runnable project by following our Quick Start guide.
+
+.. tip:: Other Kotlin Platforms for MongoDB
+
+   If your Kotlin application requires asynchronous processing, use the
+   :driver:`Coroutine Driver </kotlin/coroutine/current>`, which uses coroutines for
+   server-side applications.
+
+   If you are developing an Android or Kotlin Multiplatform (KMP)
+   application, you can use the :realm:`MongoDB Atlas Device Kotlin SDK </sdk/kotlin/>` 
+   to implement Device Sync and to manage your Realm data.
+
+Quick Start
+-----------
+
+Learn how to establish a connection to MongoDB Atlas and begin
+working with data in the :ref:`Quick Start <kotlin-sync-quick-start>` section.
+
+What's New
+----------
+
+For a list of new features and changes in each version, see the :ref:`What's New <kotlin-sync-whats-new>`
+section.
+
+Quick Reference
+---------------
+
+See driver syntax examples for common MongoDB commands in the
+:ref:`Quick Reference <kotlin-sync-quick-reference>` section.
+
+FAQ
+---
+
+For answers to commonly asked questions about the {+driver-short+}, see the
+:ref:`FAQ <kotlin-sync-faq>` section.
+
+Connection Troubleshooting
+--------------------------
+
+For solutions to some issues you might experience when connecting to a MongoDB
+deployment while using the {+driver-short+}, see the 
+:ref:`Connection Troubleshooting <kotlin-sync-connection-troubleshooting>` section.
+
+Issues & Help
+-------------
+
+Learn how to report bugs, contribute to the driver, and find more resources for
+asking questions and receiving help in the :ref:`Issues & Help <kotlin-sync-issues-and-help>` section.
+
+Compatibility
+-------------
+
+For the compatibility charts that show the recommended {+driver-short+} version for each
+MongoDB Server version, see the :ref:`Compatibility <kotlin-sync-compatibility>` section.
+
+Learn
+------
+
+Visit the Developer Hub to learn more about the {+driver-long+}.
+
+Developer Hub
+~~~~~~~~~~~~~
+
+The Developer Hub provides tutorials and social engagement for
+developers.
+
+To learn how to use MongoDB features with the {+driver-short+}, see the
+`How-Tos and Articles page <https://www.mongodb.com/developer/languages/kotlin/>`__.
+
+To ask questions and engage in discussions with fellow developers who
+use the {+driver-short+}, see the `forums page <https://www.mongodb.com/community/forums/tag/kotlin>`__.

source/issues-and-help.txt

@@ -0,0 +1,7 @@
+.. _kotlin-sync-issues-and-help:
+
+=============
+Issues & Help
+=============
+
+.. TODO

source/quick-reference.txt

@@ -0,0 +1,7 @@
+.. _kotlin-sync-quick-reference:
+
+===============
+Quick Reference
+===============
+
+.. TODO

source/quick-start.txt

@@ -0,0 +1,7 @@
+.. _kotlin-sync-quick-start:
+
+===========
+Quick Start
+===========
+
+.. TODO

source/whats-new.txt

@@ -0,0 +1,7 @@
+.. _kotlin-sync-whats-new:
+
+==========
+What's New
+==========
+
+.. TODO