Skip to content

Commit 19d3e5c

Browse files
terakilobyteterakilobyte
authored
Beginning (#1)
* initial port * clean usage examples * remove Java * remove errant files * add api link to index page * remove refs that don't exist * add pr template
1 parent 315001f commit 19d3e5c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+1236
-2
lines changed

‎.github/pull_request_template.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Pull Request Info
2+
3+
### Issue JIRA link:
4+
https://jira.mongodb.org/browse/DOCSP-NNNNN
5+
6+
### Docs staging link (requires sign-in on MongoDB Corp SSO):
7+
https://docs-mongodborg-staging.corp.mongodb.com/golang/docsworker-xlarge/NNNNNNNNNNN/
8+
9+
### Self-Review Checklist
10+
11+
- [ ] Is this free of any warnings or errors in the RST?
12+
- [ ] Did you run a spell-check?
13+
- [ ] Did you run a grammar-check?
14+
- [ ] Does it render on staging correctly?
15+
- [ ] Are all the links working?
16+
- [ ] Are the staging links in the PR description updated?

‎.gitignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Binaries for programs and plugins
2+
*.exe
3+
*.exe~
4+
*.dll
5+
*.so
6+
*.dylib
7+
8+
# Test binary, built with `go test -c`
9+
*.test
10+
11+
# Output of the go coverage tool, specifically when used with LiteIDE
12+
*.out
13+
14+
# Dependency directories (remove the comment below to include it)
15+
# vendor/
16+
17+
# Editor
18+
.vscode
19+
.idea
20+
21+
# System
22+
23+
.DS_Store

‎README.md

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

‎README.rst

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
=================================
2+
MongoDB Go Driver Documentation
3+
=================================
4+
5+
This repository contains documentation for the MongoDB Go Driver.
6+
7+
Build and Stage
8+
---------------
9+
10+
To build and stage the documentation, use the
11+
`snooty autobuilder <https://docs.google.com/document/d/1tAr5kZL0xWhAbfmn9AVsIXbF9quaFFK9nfbUhpKJEBU/edit#heading=h.lwy5m08dmc0i>`_.
12+
To get the snooty autobuilder running on your fork, add a webhook
13+
according to the autobuilder setup guide. Feel free to reach out
14+
on the *snooty-onboarding* Slack channel if you cannot access
15+
the `how-to guide <https://docs.google.com/document/d/1x6NZExTldbAZCOMdKUVdPeI-ukMM1S6qZhbKjXAZ3uQ/edit>`_.
16+
17+
Contribute
18+
----------
19+
20+
To contribute to the documentation,
21+
22+
- If you have not done so already, please sign the `MongoDB Contributor
23+
Agreement <https://www.mongodb.com/legal/contributor-agreement>`_.
24+
25+
- Fork this repository on GitHub and issue a pull request.
26+
27+
See the following documents that provide an overview of the
28+
documentation style and process:
29+
30+
- `Style Guide <http://docs.mongodb.org/manual/meta/style-guide>`_
31+
- `Documentation Practices <http://docs.mongodb.org/manual/meta/practices>`_
32+
- `Documentation Organization <http://docs.mongodb.org/manual/meta/organization>`_
33+
- `Build Instructions <http://docs.mongodb.org/manual/meta/build>`_
34+
35+
File JIRA Tickets
36+
-----------------
37+
38+
File issue reports or requests at the `Documentation Jira Project
39+
<https://jira.mongodb.org/browse/DOCS>`_.
40+
41+
Licenses
42+
--------
43+
44+
All documentation is available under the terms of a `Creative Commons
45+
License <http://creativecommons.org/licenses/by-nc-sa/3.0/>`_.
46+
47+
The MongoDB Documentation Project is governed by the terms of the
48+
`MongoDB Contributor Agreement
49+
<https://www.mongodb.com/legal/contributor-agreement>`_.
50+
51+
-- The MongoDB Docs Team
52+

‎snooty.toml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name = "golang"
2+
title = "Go"
3+
toc_landing_pages = [
4+
"/fundamentals/connection",
5+
"/fundamentals/crud",
6+
"/fundamentals/builders"
7+
]
8+
9+
[constants]
10+
version = 4.0
11+
package-name-org = "mongodb-org"
12+
pgp-version = "{+version+}"

‎source/compatibility.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Compatibility
2+
-------------
3+
4+
MongoDB Compatibility
5+
~~~~~~~~~~~~~~~~~~~~~
6+
7+
The following compatibility table specifies the recommended version(s) of the
8+
MongoDB Go Driver for use with a specific version of MongoDB.
9+
10+
The first column lists the driver version(s).
11+
12+
.. include:: /includes/mongodb-compatibility-table-go.rst
13+
14+
Language Compatibility
15+
~~~~~~~~~~~~~~~~~~~~~~
16+
17+
The following compatibility table specifies the recommended version(s) of the
18+
MongoDB Go Driver for use with a specific version of Go.
19+
20+
The first column lists the driver version(s).
21+
22+
.. include:: /includes/language-compatibility-table-go.rst

‎source/faq.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
===
2+
FAQ
3+
===
4+
5+
.. default-domain:: mongodb
6+
7+
Frequently Asked Questions
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Lorem ipsum.

‎source/figures/M220J_hero.jpg

4.71 KB
Loading

‎source/figures/agg_factory.gif

993 KB
Loading

‎source/fundamentals.txt

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
============
2+
Fundamentals
3+
============
4+
5+
.. default-domain:: mongodb
6+
7+
.. toctree::
8+
:titlesonly:
9+
:maxdepth: 1
10+
11+
12+
13+
..
14+
/fundamentals/connection
15+
/fundamentals/auth
16+
/fundamentals/enterprise-auth
17+
/fundamentals/databases-collections
18+
/fundamentals/data-formats
19+
/fundamentals/crud
20+
/fundamentals/indexes
21+
/fundamentals/aggregation
22+
/fundamentals/builders
23+
/fundamentals/collations
24+
/fundamentals/csfle
25+
/fundamentals/gridfs
26+
/fundamentals/logging
27+
/fundamentals/monitoring

0 commit comments

Comments
 (0)