Skip to content

Commit 517ebb4

Browse files
jeff-allen-mongojeff-allen-mongo
committed
First commit to seed repo
0 parents  commit 517ebb4

File tree

5 files changed

+193
-0
lines changed

5 files changed

+193
-0
lines changed

‎README.rst

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
=================================
2+
MongoDB for VS Code Documentation
3+
=================================
4+
5+
This repository contains documentation for the MongoDB for VS Code
6+
extension.
7+
8+
Building
9+
--------
10+
11+
First install `mut <https://github.com/mongodb/mut>`_.
12+
13+
Then you can download and build this documentation locally with
14+
the following command:
15+
16+
git clone https://github.com/mongodb/docs-mongodb-vscode.git
17+
cd docs-mongodb-vscode/
18+
make build
19+
20+
View ``build/master/html/index.html`` to view your current build of the
21+
documentation.
22+
23+
Contributing
24+
------------
25+
26+
To contribute to the documentation, please fork this repository on
27+
GitHub and issue a pull request. If you have not done so already,
28+
please sign the `MongoDB/10gen Contributor Agreement
29+
<https://www.mongodb.com/legal/contributor-agreement>`_.
30+
31+
See the following documents within this repository that provide a more
32+
thorough overview of the documentation style, and process. These links
33+
point back to the MongoDB Manual materials:
34+
35+
- `Style Guide <http://docs.mongodb.org/manual/meta/style-guide>`_
36+
- `Documentation Practices <http://docs.mongodb.org/manual/meta/practices>`_
37+
- `Documentation Organization <http://docs.mongodb.org/manual/meta/organization>`_
38+
- `Build Instructions <http://docs.mongodb.org/manual/meta/build>`_
39+
40+
File issue reports or requests at the `Documentation Jira Project
41+
<https://jira.mongodb.org/browse/DOCS>`_.
42+
43+
All documentation is available under the terms of a `Creative Commons
44+
License <http://creativecommons.org/licenses/by-nc-sa/3.0/>`_.
45+
46+
The MongoDB Documentation Project is governed by the terms of the
47+
`MongoDB/10gen Contributor Agreement
48+
<https://www.mongodb.com/legal/contributor-agreement>`_.
49+
50+
If you have any questions, please contact `[email protected]
51+
<mailto:[email protected]>`_.
52+
53+
-- The MongoDB/10gen Docs Team

‎conf-sitemap.xml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<site
3+
base_url="https://docs.mongodb.org/bi-connector/"
4+
store_into="build/master/sitemap.xml.gz"
5+
verbose="1"
6+
>
7+
8+
<directory
9+
path="build/public/"
10+
url="https://docs.mongodb.org/bi-connector/"
11+
default_file="index.html"
12+
/>
13+
<filter action="drop" type="wildcard" pattern="*~" />
14+
<filter action="drop" type="wildcard" pattern="*.txt" />
15+
<filter action="drop" type="wildcard" pattern="*_t" />
16+
<filter action="drop" type="wildcard" pattern="*.inv" />
17+
<filter action="drop" type="wildcard" pattern="*.asc" />
18+
<filter action="drop" type="wildcard" pattern="*.js" />
19+
<filter action="drop" type="wildcard" pattern="*.gif" />
20+
<filter action="drop" type="wildcard" pattern="*.png" />
21+
<filter action="drop" type="regexp" pattern="/\.[^/]*" />
22+
<filter action="drop" type="wildcard" pattern="*/single*"/>
23+
<filter action="drop" type="wildcard" pattern="*/_static/*" />
24+
<filter action="drop" type="wildcard" pattern="*/_images/*" />
25+
<filter action="drop" type="wildcard" pattern="*/search/" />
26+
</site>

‎snooty.toml

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
name = "mongodb-vscode"
2+
title = "MongoDB for VS Code"
3+
4+
intersphinx = ["https://docs.mongodb.com/manual/objects.inv"]
5+
6+
toc_landing_pages = []
7+
8+
[constants]
9+
vsce = "MongoDB for VS Code"
10+
11+
[substitutions]
12+
13+
2fa = ":abbr:`2FA (Two Factor Authentication)`"
14+
aki = ":abbr:`AKI (Azure Key Identifier)`"
15+
akv = ":abbr:`AKV (Azure Key Vault)`"
16+
api = ":abbr:`API (Application Programming Interface)`"
17+
arn = ":abbr:`ARN (Amazon Resource Name)`"
18+
aws = ":abbr:`AWS (Amazon Web Services)`"
19+
aws-pl = "AWS PrivateLink"
20+
aws-eni = ":abbr:`ENI (Elastic Network Interface)`"
21+
azure = ":abbr:`Azure (Microsoft Azure)`"
22+
bic-full = ":bic:`MongoDB Connector for BI </>`"
23+
bic-official = "MongoDB Connector for Business Intelligence for Atlas"
24+
bic-short = ":bic:`BI Connector </>`"
25+
bic-short-no-link = "BI Connector"
26+
bic = "BI Connector for Atlas"
27+
bson = ":abbr:`BSON (Binary Javascript Object Notation)`"
28+
certauth = "Certificate Authority"
29+
charts = "MongoDB Charts"
30+
charts-short = "Charts"
31+
cidr = ":abbr:`CIDR (Classless Inter-Domain Routing)`"
32+
cifs = ":abbr:`CIFS (Common Internet File System)`"
33+
cps = ":abbr:`CPS (Cloud Provider Snapshots)`"
34+
cmk = ":abbr:`CMK (customer master key)`"
35+
compass = "MongoDB Compass"
36+
data-lakes = "Data Lakes"
37+
data-lake = "Data Lake"
38+
datadog = "`Datadog <https://www.datadoghq.com/>`__"
39+
dns = ":abbr:`DNS (Domain Name System)`"
40+
Epoch-time-ms = "Timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
41+
epoch-time-ms = "timestamp in the number of milliseconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
42+
Epoch-time = "Timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
43+
epoch-time = "timestamp in the number of seconds that have elapsed since the `UNIX epoch <https://en.wikipedia.org/wiki/Unix_time?oldid=828172017>`__"
44+
fcv = ":abbr:`FCV (Feature Compatibility Version)`"
45+
fqdn = ":abbr:`FQDN (fully qualified domain name)`"
46+
fts = "Atlas Search"
47+
gcp = ":abbr:`GCP (Google Cloud Platform)`"
48+
global-write-clusters = "Global Clusters"
49+
global-write-cluster = "Global Cluster"
50+
global-write = "Global Writes"
51+
hmac = ":abbr:`HMAC (hash-based message authentication code)`"
52+
https = ":abbr:`HTTPS (Secure HyperText Transport Protocol)`"
53+
html = ":abbr:`HTML (Hypertext Markup Language)`"
54+
http = ":abbr:`HTTP (HyperText Transport Protocol)`"
55+
iam = ":abbr:`IAM (Identity and Access Management)`"
56+
iana = ":abbr:`IANA (Internet Assigned Numbers Authority)`"
57+
idp = ":abbr:`IdP (Identity Provider)`"
58+
idps = ":abbr:`IdPs (Identity Providers)`"
59+
iops = ":abbr:`IOPS (Input/Output Operations per Second)`"
60+
ipaddr = ":abbr:`IP (Internet Protocol)`"
61+
ipv4 = ":abbr:`IPv4 (Internet Protocol version 4)`"
62+
ipv6 = ":abbr:`IPv6 (Internet Protocol version 6)`"
63+
iso8601-duration = "Duration in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=851138376#Durations>`__ notation"
64+
iso8601-time = "Timestamp in `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__ date and time format in |utc|"
65+
iso8601 = "`ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601?oldid=793821205>`__"
66+
jira = "`Jira <https://jira.mongodb.org>`__"
67+
json = ":abbr:`JSON (Javascript Object Notation)`"
68+
kdc = ":abbr:`KDC (Key Distribution Center)`"
69+
kmip = ":abbr:`KMIP (Key Management Interoperability)`"
70+
kms = ":abbr:`KMS (Key Management Service)`"
71+
ldaps = ":abbr:`LDAPS (Secure Lightweight Directory Access Protocol)`"
72+
ldap = ":abbr:`LDAP (Lightweight Directory Access Protocol)`"
73+
mms-full = "MongoDB Cloud Manager"
74+
mms = "Cloud Manager"
75+
mongo = ":binary:`~bin.mongo`"
76+
mongod = ":binary:`~bin.mongod`"
77+
mongos = ":binary:`~bin.mongos`"
78+
nfs = ":abbr:`NFS (Network File System)`"
79+
nvme = ":abbr:`NVMe (non-volatile memory express)`"
80+
nvme-clusters = "clusters with local NVMe SSDs"
81+
pa = "Performance Advisor"
82+
pem = ":abbr:`PEM (Privacy Enhanced Mail)`"
83+
pit = ":abbr:`PIT (Point in Time)`"
84+
piv = ":abbr:`PIV (Personal Identity Verification)`"
85+
rdp = ":abbr:`RDP (Remote Desktop Protocol)`"
86+
restapi = ":abbr:`REST (Representational State Transfer)` :abbr:`API (Application Programming Interface)`"
87+
rest = ":abbr:`REST (Representational State Transfer)`"
88+
s3 = ":abbr:`S3 (Simple Storage Service)`"
89+
sak = ":abbr:`SAK (Service Account Key)`"
90+
saml = ":abbr:`SAML (Security Assertion Markup Language)`"
91+
sca = ":abbr:`SCA (Strong Customer Authentication)`"
92+
service-fullname = "MongoDB Atlas"
93+
service-pricing = "Atlas pricing page"
94+
service = "Atlas"
95+
sms = ":abbr:`SMS (short message service)`"
96+
smtp = ":abbr:`SMTP (Simple Mail Transport Protocol)`"
97+
sni = ":abbr:`SNI (Server Name Indication)`"
98+
snmp = ":abbr:`SNMP (Simple Network Management Protocol)`"
99+
spn = ":abbr:`SPN (Service Principal Name)`"
100+
ssd = ":abbr:`SSD (Solid State Disk)`"
101+
ssl = ":abbr:`SSL (Secure Sockets Layer)`"
102+
stitch-docs = "MongoDB Stitch"
103+
tcp = ":abbr:`TCP (Transmission Control Protocol)`"
104+
tls-ssl = ":abbr:`TLS (Transport Layer Security)` :abbr:`SSL (Secure Sockets Layer)`"
105+
tls = ":abbr:`TLS (Transport Layer Security)`"
106+
totp = ":abbr:`TOTP (Time-based One-time Password Algorithm)`"
107+
udp = ":abbr:`UDP (User Datagram Protocol)`"
108+
upn = ":abbr:`UPN (User Principal Name)`"
109+
uri = ":abbr:`URI (Uniform Resource Identifier)`"
110+
url = ":abbr:`URL (Uniform Resource Locator)`"
111+
utc = ":abbr:`UTC (Coordinated Universal Time)`"
112+
vpc = ":abbr:`VPC (Virtual Private Cloud)`"
113+
yaml = ":abbr:`YAML (Yet Another Markup Language)`"

‎source/.static/.mongodb

Whitespace-only changes.

‎worker.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"build-and-stage-next-gen"

0 commit comments

Comments
 (0)