Skip to content

Commit 033ba0a

Browse files
mongoKartmongoKart
authored
Merge pull request #1 from mongoKart/add-initial-files
Add initial files
2 parents 96003fa + ad92a81 commit 033ba0a

File tree

12 files changed

+705
-0
lines changed

12 files changed

+705
-0
lines changed

‎.github/pull_request_template.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Pull Request Info
2+
3+
[PR Reviewing Guidelines](https://github.com/mongodb/docs-golang/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?

‎.github/workflows/checker.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Link Checker
2+
on: [push, pull_request]
3+
jobs:
4+
build:
5+
name: Build
6+
runs-on: ubuntu-latest
7+
steps:
8+
- name: Set up Go 1.17
9+
uses: actions/setup-go@v2
10+
with:
11+
go-version: 1.17
12+
13+
- name: Check out source code
14+
uses: actions/checkout@v2
15+
with:
16+
fetch-depth: 2
17+
18+
- name: Install checker tool
19+
run: go install github.com/terakilobyte/checker@latest
20+
21+
- name: Run checker tool
22+
run: git diff --name-only HEAD^..HEAD | tr "\n" "," | xargs checker --changes

‎.github/workflows/copy-compat-to-docs-shared.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Copy Files to docs-shared
2+
3+
on:
4+
push:
5+
branches:
6+
- "master"
7+
paths:
8+
- "source/includes/mongodb-compatibility-table-csharp.rst"
9+
- "source/includes/language-compatibility-table-csharp.rst"
10+
11+
jobs:
12+
copy-file:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v2
17+
18+
- name: Copy mongodb-compat table
19+
uses: dmnemec/copy_file_to_another_repo_action@main
20+
env:
21+
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
22+
with:
23+
source_file: "source/includes/mongodb-compatibility-table-csharp.rst"
24+
destination_repo: "10gen/docs-shared"
25+
destination_folder: "dbx"
26+
user_email: "mike.woofter@mongodb.com"
27+
user_name: "mongoKart"
28+
commit_message: "Auto-import from docs-csharp"
29+
30+
- name: Copy language-compat table
31+
uses: dmnemec/copy_file_to_another_repo_action@main
32+
env:
33+
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
34+
with:
35+
source_file: "source/includes/language-compatibility-table-csharp.rst"
36+
destination_repo: "10gen/docs-shared"
37+
destination_folder: "dbx"
38+
user_email: "mike.woofter@mongodb.com"
39+
user_name: "mongoKart"
40+
commit_message: "Auto-import from docs-csharp"

‎.gitignore‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Binaries for programs and plugins
2+
*.exe
3+
*.exe~
4+
*.dll
5+
*.so
6+
*.dylib
7+
8+
# Dependency directories (remove the comment below to include it)
9+
# vendor/
10+
11+
# Editor
12+
.vscode
13+
.idea
14+
15+
# System
16+
17+
.DS_Store

‎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 C#/.NET 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: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
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
9+
...

‎config/redirects‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
define: prefix docs/drivers/csharp
2+
define: base https://www.mongodb.com/${prefix}
3+
define: versions 2.17 master
4+
5+
raw: ${prefix}/ -> ${base}/current/
6+
raw: ${prefix}/stable -> ${base}/current/

‎snooty.toml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name = "csharp"
2+
title = "C#/.NET"
3+
toc_landing_pages = [
4+
"/fundamentals/connection",
5+
"/fundamentals/crud",
6+
"/usage-examples"
7+
]
8+
9+
intersphinx = [
10+
"https://www.mongodb.com/docs/manual/objects.inv",
11+
"https://www.mongodb.com/docs/drivers/objects.inv",
12+
"https://www.mongodb.com/docs/atlas/objects.inv"
13+
]
14+
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
15+
16+
[constants]
17+
driver-long = "MongoDB C#/.NET Driver"
18+
docs-branch = "main" # always set this to the docs branch (i.e. master, 1.7, 1.8, etc.)
19+
version = "v2.17" # always set this to the driver branch (i.e. v1.7.0, v1.8.0, etc.)
20+
example = "https://raw.githubusercontent.com/mongodb/docs-csharp/{+docs-branch+}/source/includes/usage-examples/code-snippets"
21+
stable-api = "Stable API"

‎source/compatibility.txt‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. _csharp-compatibility-tables:
2+
3+
=============
4+
Compatibility
5+
=============
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
14+
MongoDB Compatibility
15+
---------------------
16+
17+
The following compatibility table specifies the recommended version(s) of the
18+
{+driver-long+} for use with a specific version of MongoDB.
19+
20+
The first column lists the driver version(s).
21+
22+
.. sharedinclude:: dbx/compatibility-table-legend.rst
23+
24+
.. include:: /includes/mongodb-compatibility-table-csharp.rst
25+
26+
Language Compatibility
27+
----------------------
28+
29+
The following compatibility table specifies the recommended version(s) of the
30+
{+driver-long+} for use with a specific version of C#.
31+
32+
The first column lists the driver version(s).
33+
34+
.. include:: /includes/language-compatibility-table-csharp.rst
35+
36+
For more information on how to read the compatibility tables, see our guide on
37+
:ref:`MongoDB Compatibility Tables. <about-driver-compatibility>`

0 commit comments

Comments
 (0)