Skip to content

Commit a151678

Browse files
mongoKartmongoKart
committed
scaffolding
1 parent 23a5e18 commit a151678

File tree

6 files changed

+116
-0
lines changed

6 files changed

+116
-0
lines changed

‎README.rst

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

‎config/intersphinx.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Weirdly, giza wants a non-empty list of two or more, so we have to include extraneous/unused one --hence the python
2+
name: python
3+
url: https://docs.python.org/2/
4+
path: python2.inv
5+
---
6+
name: mongodb
7+
url: https:/www.mongodb.com/docs/manual/
8+
path: mongodb.inv

‎config/redirects

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
define: prefix docs/languages/python/drivers/pymongo
2+
define: base https://www.mongodb.com/${prefix}
3+
define: versions v4.6 master
4+
5+
symlink: current -> master
6+
7+
raw: ${prefix}/ -> ${base}/current/
8+
raw: ${prefix}/stable -> ${base}/current/
9+
raw: ${prefix}/master -> ${base}/upcoming/
10+

‎snooty.toml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name = "pymongo"
2+
title = "PyMongo"
3+
toc_landing_pages = [
4+
]
5+
6+
intersphinx = [
7+
"https://www.mongodb.com/docs/manual/objects.inv",
8+
"https://www.mongodb.com/docs/drivers/objects.inv",
9+
"https://www.mongodb.com/docs/atlas/objects.inv",
10+
]
11+
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
12+
13+
[constants]
14+
driver-short = "PyMongo"
15+
language = "Python"
16+
mongo-community = "MongoDB Community Edition"
17+
mongo-enterprise = "MongoDB Enterprise Edition"
18+
docs-branch = "master" # always set this to the docs branch (i.e. master, 1.7, 1.8, etc.)
19+
version-number = "4.6"
20+
patch-version-number = "{+version-number+}.1" # always set this to the driver branch (i.e. 1.7.0, 1.8.0, etc.)
21+
version = "v{+version-number+}"
22+
example = "https://raw.githubusercontent.com/mongodb/docs-pymongo/{+docs-branch+}/source/includes/code-examples"
23+
stable-api = "Stable API"
24+
api-root = "https://pymongo.readthedocs.io/en/{+patch-version-number+}/api/index.html"

‎source/facets.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
[[facets]]
2+
category = "programming_language"
3+
value = "python"
4+
5+
[[facets]]
6+
category = "target_product"
7+
value = "drivers"

0 commit comments

Comments
 (0)