Skip to content

Commit 90d121f

Browse files
rustagirrustagir
authored
Merge pull request #1 from rustagir/DOCSP-30504-configure-repo
DOCSP-30504: setup rust repo base files
2 parents b728728 + 99255c4 commit 90d121f

File tree

7 files changed

+203
-7
lines changed

7 files changed

+203
-7
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-rust/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/check-autobuilder.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
name: Check Autobuilder for Errors
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "source/**"
7+
8+
jobs:
9+
check:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
- uses: cbush/snooty-autobuilder-check@main

‎.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

‎REVIEWING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Pull Request Reviewing Guidelines for Rust 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
26+
scope of the JIRA ticket, or otherwise create tickets to address
27+
anything unrelated.
28+
29+
## Technical Review
30+
31+
Review the technical accuracy and completeness of a PR and correct it if necessary.
32+
33+
### What to Review
34+
35+
- 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")
36+
- Problematic explanations that could trip up users who try to follow the documentation.
37+
38+
### What Not to Review
39+
40+
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.
41+
42+
- Wording of sentences, although corrections to technical claims are welcome
43+
- Structure of the page
44+
- Any unchanged lines outside the PR unless relevant to the ticket acceptance criteria.

‎config/intersphinx.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
name: python
2+
url: https://docs.python.org/2/
3+
path: python2.inv
4+
---
5+
name: mongodb
6+
url: https:/www.mongodb.com/docs/manual/
7+
path: mongodb.inv

‎config/redirects

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
define: prefix docs/drivers/rust
2-
define: base https://www.mongodb.com/docs/
2+
define: base https://www.mongodb.com/${prefix}
33
define: versions master
44

5-
# raw: ${prefix}/${<version or alias>}/<source file> -> ${base}/<destination>
5+
symlink: current -> master
66

7+
raw: ${prefix}/ -> ${base}/current/
8+
raw: ${prefix}/stable -> ${base}/current/

‎source/index.txt

Lines changed: 99 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,102 @@
1-
===========
2-
Rust Driver
3-
===========
1+
===================
2+
{+driver-long+}
3+
===================
44

5-
Your words here. Don't forget to add a toctree!
5+
.. toctree::
6+
:titlesonly:
7+
:maxdepth: 1
68

7-
Have a lovely day!
9+
View the Source <https://github.com/mongodb/mongo-rust-driver>
810

11+
..
12+
/quick-start
13+
/quick-reference
14+
/whats-new
15+
/usage-examples
16+
/fundamentals
17+
API Documentation <{+api+}/mongo>
18+
/faq
19+
/connection-troubleshooting
20+
/issues-and-help
21+
/compatibility
22+
23+
Introduction
24+
------------
25+
26+
Welcome to the documentation site for the official {+driver-long+}.
27+
You can add the driver to your application to work with MongoDB in Rust.
28+
Import it by adding it to your project's ``Cargo.toml`` file or set up a
29+
runnable project by following our Quick Start guide.
30+
31+
Quick Start
32+
-----------
33+
34+
.. Learn how to establish a connection to MongoDB Atlas and begin
35+
.. working with data in the :ref:`rust-quickstart` section.
36+
37+
Quick Reference
38+
---------------
39+
40+
.. See driver syntax examples for common MongoDB commands in the
41+
.. :ref:`Quick Reference <rust-quick-reference>` section.
42+
43+
What's New
44+
----------
45+
46+
.. For a list of new features and changes in each version, see the
47+
.. :ref:`rust-whats-new` section.
48+
49+
Usage Examples
50+
--------------
51+
52+
.. For fully runnable code snippets and explanations for common
53+
.. methods, see :ref:`rust-usage-examples`.
54+
55+
Fundamentals
56+
------------
57+
58+
.. .. include:: /includes/fundamentals-sections.rst
59+
60+
API
61+
---
62+
63+
For detailed information about types and methods in the {+driver-long+},
64+
see the `API documentation <{+api+}/>`__.
65+
66+
FAQ
67+
---
68+
69+
.. For answers to commonly asked questions about the {+driver-long+}, see
70+
.. the :ref:`rust-faq` section.
71+
72+
Issues & Help
73+
-------------
74+
75+
.. Learn how to report bugs, contribute to the driver, and find
76+
.. additional resources for asking questions in the :ref:`rust-issues-and-help` section.
77+
78+
Compatibility
79+
-------------
80+
81+
.. For the compatibility charts that show the recommended {+driver-short+} version
82+
.. for each MongoDB Server version, see :ref:`rust-compatibility`.
83+
84+
Learn
85+
------
86+
87+
Visit the Developer Hub to learn more about the {+driver-long+}.
88+
89+
Developer Hub
90+
~~~~~~~~~~~~~
91+
92+
The Developer Hub provides tutorials and social engagement for
93+
developers.
94+
95+
To learn how to use MongoDB features with the {+driver-short+}, see the
96+
`Rust page <https://www.mongodb.com/developer/languages/rust/>`__ in the
97+
MongoDB Developer Center.
98+
99+
To ask questions and engage in discussions with fellow developers who
100+
use the {+driver-short+}, see the `Rust tag
101+
<https://www.mongodb.com/community/forums/tag/rust>`__ in the MongoDB
102+
Community Forums.

0 commit comments

Comments
 (0)