Skip to content

Commit 63a4a32

Browse files
Merge pull request #9 from jwilliams-mongo/v1.0
V1.0
2 parents 9a59ce0 + b8ce3a3 commit 63a4a32

File tree

933 files changed

+52051
-12
lines changed

Some content is hidden

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

933 files changed

+52051
-12
lines changed

.backportrc.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"repoOwner": "10gen",
3+
"repoName": "docs-mck",
4+
5+
"targetBranchChoices": ["v1.0"],
6+
7+
"editor": "code",
8+
9+
"maxNumber": 15,
10+
11+
"backportBranchName": "{{sourcePullRequest.number}}-{{targetBranch}}-backport",
12+
13+
"prTitle": "{{sourcePullRequest.title}}-{{targetBranch}}-backport ({{sourcePullRequest.number}})"
14+
}

.github/pull-request-template.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!-- Add a description of your PR here (optional) -->
2+
3+
- [DOCSP-number](https://jira.mongodb.org/browse/)
4+
- [STAGING](paste the link to staging here)
5+
6+
- [LATEST BUILD LOG](paste the build here)
7+
8+
### Self-Review Checklist
9+
10+
- [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page.
11+
- [ ] Add genre facets (tutorial or reference), as in this [example PR](https://github.com/10gen/cloud-docs/pull/5042).
12+
- [ ] Add programmingLanguage (if necessary).
13+
- [ ] Add meta keywords (if necessary).
14+
- [ ] Resolve any new warnings or errors in the build.
15+
- [ ] Proofread for spelling and grammatical errors.
16+
- [ ] Check staging for rendering issues.
17+
- [ ] Confirm links are working.

.gitignore

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
1+
.DS_Store
12
build/*
23
*.swp
34
.#*
45
\#*#
6+
*.pyc
7+
*.pyo
8+
fabfile
9+
docs_meta.yaml
10+
meta.yaml
11+
source/includes/table-*rst
12+
source/includes/hash.rst
13+
source/includes/toc-*rst
14+
source/includes/dfn-*rst
15+
source/includes/table-*rst
16+
source/includes/toc/
17+
source/includes/table/
18+
source/includes/steps/
19+
handouts/build
20+
handouts/logo.png
21+
handouts/mongodb-logo.eps
22+
handouts/mongodb-logo-eps-converted-to.pdf
23+
source/figures/
24+
giza.log
25+
backups/*
26+
.vscode/*
27+
tools/license-tool/target/
28+
tools/license-tool/licenses.csv
529
*__pycache__*
630
*.pyc
731
docs/index.html

.static/logo-mongodb.png

3.19 KB
Loading

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# docs-mck
22

3-
MongoDB Controllers for Kubernetes
3+
MongoDB Controllers for Kubernetes Operator
44

55
[Your words here].
66

README.rst

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
====================================================
2+
MongoDB Controllers for Kubernetes Operator Documentation
3+
====================================================
4+
5+
This repository contains documentation regarding components of the
6+
the MongoDB Controllers for Kubernetes Operator.
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-k8s-operator.git
17+
cd docs-k8s-operator/
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

0 commit comments

Comments
 (0)