Skip to content

Commit e213d40

Browse files
mcmorisimcmorisi
authored
DOCSP-41157: Set up initial repo and index page (#2)
1 parent ebc6ef1 commit e213d40

16 files changed

+278
-27
lines changed

‎.github/pull_request_template.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Pull Request Info
2+
3+
[PR Reviewing Guidelines](https://github.com/mongodb/docs-kotlin-sync/blob/master/REVIEWING.md)
4+
5+
JIRA - <https://jira.mongodb.org/browse/DOCSP-NNNNN>
6+
Staging - <https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/NNNNN/>
7+
8+
## Self-Review Checklist
9+
10+
- [ ] Is this free of any warnings or errors in the RST?
11+
- [ ] Did you run a spell-check?
12+
- [ ] Did you run a grammar-check?
13+
- [ ] Are all the links working?
14+
- [ ] Are the [facets and meta keywords](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) accurate?

‎.github/workflows/check-autobuilder.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Check Autobuilder for Errors
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "source/**"
7+
8+
jobs:
9+
check:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
- uses: cbush/snooty-autobuilder-check@main

‎.github/workflows/vale-tdbx.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: vale-checks
2+
on:
3+
pull_request:
4+
paths:
5+
- "source/**"
6+
7+
jobs:
8+
vale:
9+
name: TDBX Vale rules
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: checkout
13+
uses: actions/checkout@master
14+
15+
- id: files
16+
uses: masesgroup/retrieve-changed-files@v2
17+
with:
18+
format: 'csv'
19+
20+
- name: checkout-latest-rules
21+
uses: actions/checkout@master
22+
with:
23+
repository: mongodb/mongodb-vale-action
24+
path: './tdbx-vale-rules'
25+
token: ${{secrets.GITHUB_TOKEN}}
26+
27+
- name: move-files-for-vale-action
28+
run: |
29+
cp tdbx-vale-rules/.vale.ini .vale.ini
30+
mkdir -p .github/styles/
31+
cp -rf tdbx-vale-rules/.github/styles/ .github/
32+
33+
- name: run-vale
34+
uses: errata-ai/vale-action@reviewdog
35+
with:
36+
reporter: github-pr-check
37+
files: ${{steps.files.outputs.added_modified}}
38+
fail_on_error: true
39+
token: ${{secrets.GITHUB_TOKEN}}

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.vscode

‎README.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

‎README.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
==================================
2+
{+driver-long+} Documentation
3+
==================================
4+
5+
This repository contains documentation for the {+driver-short+}.
6+
7+
## File JIRA Tickets
8+
9+
Please file issue reports or requests at the `Documentation Jira Project
10+
<https://jira.mongodb.org/browse/DOCS>`_.
11+
12+
## Licenses
13+
14+
All documentation is available under the terms of a `Creative Commons
15+
License <https://creativecommons.org/licenses/by-nc-sa/3.0/>`_.
16+
17+
The MongoDB Documentation Project is governed by the terms of the
18+
`MongoDB Contributor Agreement
19+
<https://www.mongodb.com/legal/contributor-agreement>`_.
20+
21+
-- The MongoDB Documentation Team

‎REVIEWING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Pull Request Reviewing Guidelines for Kotlin Sync Driver Documentation
2+
3+
Contributions to the set of documents in this repository can receive reviews from one or both of the following types of reviews:
4+
5+
1. A **copy review**, which focuses on information structure and wording; typically performed by a MongoDB Documentation Team member
6+
2. A **technical review**, which addresses code snippets and the technical correctness of prose; typically performed by a MongoDB engineer.
7+
8+
See the following sections for reviewer expectations for each type of pull request (PR) review:
9+
10+
## Copy Review
11+
12+
Review the structure, wording, and flow of the information in the PR, and correct it if necessary.
13+
14+
### What to Review
15+
16+
- Wording
17+
- Page structure
18+
- Technical content to the extent of the reviewer’s understanding.
19+
- Whether the PR fulfills the Acceptance Criteria described in the
20+
linked JIRA ticket.
21+
22+
### What Not to Review
23+
24+
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.
25+
Copy reviewers should constrain their reviews to content within the scope of the JIRA ticket, or otherwise create PRs to address anything unrelated.
26+
27+
## Technical Review
28+
29+
Review the technical accuracy and completeness of a PR and correct it if necessary.
30+
31+
### What to Review
32+
33+
- 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")
34+
- Problematic explanations that could trip up users who try to follow the documentation.
35+
36+
### What Not to Review
37+
38+
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.
39+
40+
- Wording of sentences, although corrections to technical claims are welcome
41+
- Structure of the page
42+
- Any unchanged lines outside the PR unless relevant to the ticket acceptance criteria.

‎snooty.toml

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,19 @@ name = "kotlin-sync"
22
title = "Kotlin Sync Driver"
33

44
intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv",
5+
"https://www.mongodb.com/docs/drivers/objects.inv",
56
"https://www.mongodb.com/docs/atlas/objects.inv"
67
]
78

8-
# toc_landing_pages = ["/paths/to/pages/that/have/nested/content"]
9+
toc_landing_pages = []
910

10-
# [constants]
11-
# constant = "value"
11+
[constants]
12+
driver-long = "MongoDB Kotlin Sync Driver"
13+
driver-short = "Kotlin Sync driver"
14+
language = "Kotlin"
15+
version-number = "5.1"
16+
version = "v{+version-number+}"
17+
patch-version-number = "{+version-number+}.0"
18+
mdb-server = "MongoDB Server"
19+
stable-api = "Stable API"
20+
api = "https://mongodb.github.io/mongo-java-driver/{+version-number+}/apidocs/mongodb-driver-kotlin-sync"

‎source/compatibility.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _kotlin-sync-compatibility:
2+
3+
=============
4+
Compatibility
5+
=============
6+
7+
.. TODO

‎source/connection-troubleshooting.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. _kotlin-sync-connection-troubleshooting:
2+
3+
==========================
4+
Connection Troubleshooting
5+
==========================
6+
7+
.. TODO

0 commit comments

Comments
 (0)