Skip to content

Commit 8f0e10d

Browse files
jordan-smith721jordan-smith721
committedDec 5, 2022
scaffolding
1 parent c30f3c2 commit 8f0e10d

8 files changed

+202
-0
lines changed
 

‎.gitignore

+17
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

‎README.rst

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

‎config/intersphinx.yaml

+8
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

+6
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.18 master
4+
5+
raw: ${prefix}/ -> ${base}/current/
6+
raw: ${prefix}/stable -> ${base}/current/

‎snooty.toml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name = "csharp"
2+
title = "C#/.NET"
3+
toc_landing_pages = [
4+
"/fundamentals/connection",
5+
"/fundamentals/crud",
6+
"/usage-examples",
7+
"/fundamentals",
8+
]
9+
10+
intersphinx = [
11+
"https://www.mongodb.com/docs/manual/objects.inv",
12+
"https://www.mongodb.com/docs/drivers/objects.inv",
13+
"https://www.mongodb.com/docs/atlas/objects.inv",
14+
]
15+
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
16+
17+
[constants]
18+
driver-long = "MongoDB .NET/C# Driver"
19+
driver-short = ".NET/C# Driver"
20+
lang-framework = ".NET/C#"
21+
framework = ".NET framework"
22+
framework-version = "4.8"
23+
standard-version = "2.1"
24+
language = "C#"
25+
mongo-community = "MongoDB Community Edition"
26+
mongo-enterprise = "MongoDB Enterprise Edition"
27+
docs-branch = "master" # always set this to the docs branch (i.e. master, 1.7, 1.8, etc.)
28+
version-number = "2.18" # always set this to the driver branch (i.e. 1.7.0, 1.8.0, etc.)
29+
version = "v{+version-number+}"
30+
example = "https://raw.githubusercontent.com/mongodb/docs-csharp/{+docs-branch+}/source/includes/usage-examples/code-examples"
31+
stable-api = "Stable API"
32+
api-root = "https://mongodb.github.io/mongo-csharp-driver/{+version-number+}/apidocs/html"
33+
bool-data-type = "``bool``"
34+
string-data-type = "``str``"
35+
int-data-type = "``int``"
36+
not-available = "N/A"

‎source/index.txt

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
=================
2+
MongoDB C# Driver
3+
=================
4+
5+
.. default-domain:: mongodb
6+
7+
.. toctree::
8+
9+
/quick-start
10+
/quick-reference
11+
/usage-examples
12+
/fundamentals
13+
API Documentation <{+api-root+}/R_Project_CSharpDriverDocs.htm>
14+
/compatibility
15+
/issues-and-help
16+
/faq
17+
18+
Introduction
19+
------------
20+
21+
Welcome to the documentation site for the official {+driver-long+}.
22+
You can add the driver to your application to work with MongoDB in {+language+}.
23+
Download the driver using `NuGet <https://www.nuget.org/packages/MongoDB.Driver>`__, or set up a runnable
24+
project by following our :ref:`Quick Start guide <csharp-quickstart>`.
25+
26+
Quick Start
27+
-----------
28+
29+
Learn how to establish a connection to MongoDB Atlas and begin
30+
working with data in the :ref:`csharp-quickstart` section.
31+
32+
Quick Reference
33+
---------------
34+
35+
See driver syntax examples for common MongoDB commands in the
36+
:ref:`Quick Reference <csharp-quick-reference>` section.
37+
38+
Usage Examples
39+
--------------
40+
41+
For fully runnable code snippets and explanations for common
42+
methods, see :ref:`csharp-usage-examples`.
43+
44+
Fundamentals
45+
------------
46+
47+
For detailed information on key concepts of using the {+driver-short+}, see
48+
:ref:`csharp-fundamentals`.
49+
50+
API Documentation
51+
-----------------
52+
53+
For detailed information about types and methods in the {+driver-short+}, see
54+
the `{+driver-long+} API documentation <{+api-root+}/R_Project_CSharpDriverDocs.htm>`__.
55+
56+
Compatibility
57+
-------------
58+
59+
For the compatibility charts that show the recommended {+driver-short+} version
60+
for each MongoDB Server version, see :ref:`csharp-compatibility-tables`.
61+
62+
Issues & Help
63+
-------------
64+
65+
Learn how to report bugs, contribute to the driver, and find
66+
additional resources for asking questions in the :ref:`csharp-issues-help` section.
67+
68+
FAQ
69+
---
70+
71+
For answers to commonly asked questions about the {+driver-long+}, see the :ref:`csharp-faq`
72+
section.

‎source/issues-and-help.txt

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
.. _csharp-issues-help:
2+
3+
=============
4+
Issues & Help
5+
=============
6+
7+
.. default-domain:: mongodb
8+
9+
We are lucky to have a vibrant community of {+driver-long+}
10+
users. We recommend seeking support for general
11+
questions through the `MongoDB Community Forums
12+
<https://www.mongodb.com/community/forums>`__.
13+
14+
Bugs / Feature Requests
15+
-----------------------
16+
17+
To report a bug or to request a new feature in the {+driver-short+},
18+
please open an issue in JIRA, our issue management tool, using the
19+
following steps:
20+
21+
1. `Create a JIRA account <https://jira.mongodb.org>`__.
22+
#. Navigate to `the CSHARP Driver project <https://jira.mongodb.org/browse/CSHARP>`__.
23+
#. Click :guilabel:`Create Issue`. Please provide as much information as possible about the
24+
issue and the steps to reproduce it.
25+
26+
Bug reports in JIRA for the CSHARP Driver project can be viewed by everyone.
27+
28+
If you identify a security vulnerability in the driver or in any other
29+
MongoDB project, please report it according to the instructions found in
30+
:manual:`Create a Vulnerability Report </tutorial/create-a-vulnerability-report>`.
31+
32+
Pull Requests
33+
-------------
34+
35+
We are happy to accept contributions to help improve the driver. To
36+
contribute to the official driver, follow the `development and testing
37+
guidelines <https://github.com/mongodb/mongo-csharp-driver/blob/master/CONTRIBUTING.md>`__.
38+
We will guide user contributions to ensure they meet the standards of the codebase.

‎worker.sh

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"build-and-stage-next-gen"

0 commit comments

Comments
 (0)
Please sign in to comment.