Skip to content

Commit 00ccf5f

Browse files
terakilobyteterakilobyte
committed
initial commit
0 parents  commit 00ccf5f

24 files changed

+1057
-0
lines changed

‎.gitignore‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
build/
2+
*pyc
3+
source/includes/table-*rst
4+
source/images/*
5+
DS_Store
6+
.DS_Store
7+
.#*
8+
*.bak
9+
source/images
10+
source/figures
11+
meta.yaml
12+
source/includes/hash.rst
13+
source/includes/table/
14+
source/includes/toc
15+
fabfile
16+
giza.log

‎.static/logo-mongodb.png‎

3.19 KB
Loading

‎Makefile‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
GIT_BRANCH=$(shell git rev-parse --abbrev-ref HEAD)
2+
USER=$(shell whoami)
3+
STAGING_URL="https://docs-mongodborg-staging.corp.mongodb.com"
4+
PRODUCTION_URL="https://docs.mongodb.com/ecosystem"
5+
STAGING_BUCKET=docs-mongodb-org-staging
6+
PRODUCTION_BUCKET=docs-mongodb-org-prod
7+
8+
# "PROJECT" currently exists to support having multiple projects
9+
# within one bucket.
10+
PROJECT=ecosystem
11+
12+
.PHONY: help lint html stage deploy deploy-search-index
13+
14+
help: ## Show this help message
15+
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
16+
@echo
17+
@echo 'Variables'
18+
@printf " \033[36m%-18s\033[0m %s\n" 'ARGS' 'Arguments to pass to mut-publish'
19+
20+
html: ## Builds this branch's HTML under build/<branch>/html
21+
giza make html
22+
23+
publish: ## Builds this branch's publishable HTML and other artifacts under build/public
24+
if [ ${GIT_BRANCH} = master ]; then rm -rf build/master build/public; fi
25+
giza make publish
26+
if [ ${GIT_BRANCH} = master ]; then mut-redirects config/redirects -o build/public/.htaccess; fi
27+
28+
lint: ## Checks URLs in the built corpus underneath build/<branch>/html
29+
mut-lint --linters=links ./build/master/source/ ${ARGS}
30+
31+
stage: ## Host online for review
32+
mut-publish build/${GIT_BRANCH}/html ${STAGING_BUCKET} --prefix=${PROJECT} --stage ${ARGS}
33+
@echo "Hosted at ${STAGING_URL}/${PROJECT}/${USER}/${GIT_BRANCH}/index.html"
34+
35+
deploy: build/public ## Deploy to the production bucket
36+
mut-publish build/public ${PRODUCTION_BUCKET} --prefix=${PROJECT} --deploy --redirect-prefix='ecosystem' --all-subdirectories ${ARGS}
37+
38+
@echo "Hosted at ${PRODUCTION_URL}/index.html"
39+
40+
$(MAKE) deploy-search-index
41+
42+
deploy-search-index: ## Update the search index for this branch
43+
@echo "Building search index"
44+
mut-index upload build/public -o ${PROJECT}-${GIT_BRANCH}.json -u ${PRODUCTION_URL} -s

‎README.rst‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
===========================
2+
MongoDB Realm Documentation
3+
===========================
4+
5+
This repository contains documentation regarding components of
6+
MongoDB Realm .
7+
8+
This documentation builds on the work of the `MongoDB
9+
Manual <http://docs.mongodb.org/manual/>`. You can download and build
10+
this documentation locally if you already have `Sphinx
11+
<http://sphinx.pocoo.org/>`_ installed, with the following command: ::
12+
13+
pip install giza
14+
git clone git://github.com/mongodb/docs-ecosystem
15+
cd docs-ecosystem/
16+
make html
17+
18+
To build on Windows (using Cygwin):
19+
20+
- Ensure you have python installed
21+
- install Sphinx using ``easy_install -U Sphinx``
22+
- install pyyamml using ``pip install pyyaml``
23+
- Build the docs using ``sphinx-build -b html -d build/doctrees-html -c ./ source build/html``
24+
25+
You may also wish to install `Pygments
26+
<http://pygments.org>`_ to provide syntax highlighting for code
27+
examples.
28+
29+
Contribute
30+
----------
31+
32+
The MongoDB Documentation Project is governed by the terms of the
33+
`MongoDB Contributor Agreement
34+
<https://www.mongodb.com/legal/contributor-agreement>`_.
35+
36+
To contribute to the documentation,
37+
38+
- If you have not done so already, please sign the `MongoDB Contributor Agreement <https://www.mongodb.com/legal/contributor-agreement>`_.
39+
40+
- Fork this repository on GitHub and issue a pull request.
41+
42+
43+
Report Issues
44+
-------------
45+
46+
File issue reports or requests at the `Documentation Jira Project
47+
<https://jira.mongodb.org/browse/DOCS>`_.
48+
49+
License
50+
-------
51+
52+
All documentation is available under the terms of a `Creative Commons
53+
License <http://creativecommons.org/licenses/by-nc-sa/3.0/>`_.
54+
55+
If you have any questions, please contact `docs@10gen.com
56+
<mailto:docs@10gen.com>`_.
57+
58+
-- 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.com/realm/"
4+
store_into="build/master/sitemap.xml.gz"
5+
verbose="1"
6+
>
7+
8+
<directory
9+
path="build/public/"
10+
url="https://docs.mongodb.com/realm/"
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>

‎conf.py‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# MongoDB documentation build configuration file, created by
4+
# sphinx-quickstart on Mon Oct 3 09:58:40 2011.
5+
#
6+
# This file is execfile()d with the current directory set to its containing dir.
7+
8+
import sys
9+
import os.path
10+
import datetime
11+
12+
project_root = os.path.join(os.path.abspath(os.path.dirname(__file__)))
13+
sys.path.append(project_root)
14+
15+
from giza.config.runtime import RuntimeStateConfig
16+
from giza.config.helper import fetch_config, get_versions, get_manual_path
17+
18+
conf = fetch_config(RuntimeStateConfig())
19+
intersphinx_libs = conf.system.files.data.intersphinx
20+
sconf = conf.system.files.data.sphinx_local
21+
22+
sys.path.append(os.path.join(conf.paths.projectroot, conf.paths.buildsystem, 'sphinxext'))
23+
24+
# -- General configuration ----------------------------------------------------
25+
26+
needs_sphinx = '1.0'
27+
28+
extensions = [
29+
'sphinx.ext.extlinks',
30+
'sphinx.ext.todo',
31+
'mongodb',
32+
'directives',
33+
'intermanual',
34+
'fasthtml'
35+
]
36+
37+
templates_path = ['.templates']
38+
exclude_patterns = []
39+
40+
source_suffix = '.txt'
41+
42+
master_doc = sconf.master_doc
43+
language = 'en'
44+
project = sconf.project
45+
copyright = u'2008-{0}'.format(datetime.date.today().year)
46+
47+
version = '3.0'
48+
release = version
49+
50+
rst_epilog = '\n'.join([
51+
'.. |branch| replace:: ``{0}``'.format(conf.git.branches.current),
52+
'.. |copy| unicode:: U+000A9',
53+
'.. |year| replace:: {0}'.format(datetime.date.today().year),
54+
'.. |ent-build| replace:: MongoDB Enterprise',
55+
'.. |hardlink| replace:: http://docs.mongodb.com/realm/',
56+
'.. |atlas-full| replace:: MongoDB Atlas',
57+
'.. |atlas| replace:: Atlas'
58+
])
59+
60+
extlinks = {
61+
'issue': ('https://jira.mongodb.org/browse/%s', '' ),
62+
'api': ('http://api.mongodb.com/%s', ''),
63+
'manual': ('http://docs.mongodb.org/manual%s', ''),
64+
'gettingstarted': ('http://docs.mongodb.org/getting-started%s', ''),
65+
'atlas': ('https://docs.atlas.mongodb.com%s',''),
66+
'mms-docs': ('https://docs.cloud.mongodb.com%s', ''),
67+
'mms-home': ('https://cloud.mongodb.com%s', ''),
68+
'guides': ('https://docs.mongodb.com/guides%s', ''),
69+
'java-docs-latest': ('http://mongodb.github.io/mongo-java-driver/3.11/%s', ''),
70+
}
71+
72+
intersphinx_mapping = {}
73+
74+
try:
75+
for i in intersphinx_libs:
76+
intersphinx_mapping[i['name']] = ( i['url'], os.path.join(conf.paths.projectroot,
77+
conf.paths.output,
78+
i['path']))
79+
except:
80+
for i in intersphinx_libs:
81+
intersphinx_mapping[i.name] = ( i.url, os.path.join(conf.paths.projectroot,
82+
conf.paths.output,
83+
i.path))
84+
85+
86+
languages = [
87+
("ar", "Arabic"),
88+
("cn", "Chinese"),
89+
("cs", "Czech"),
90+
("de", "German"),
91+
("es", "Spanish"),
92+
("fr", "French"),
93+
("hu", "Hungarian"),
94+
("id", "Indonesian"),
95+
("it", "Italian"),
96+
("jp", "Japanese"),
97+
("ko", "Korean"),
98+
("lt", "Lithuanian"),
99+
("pl", "Polish"),
100+
("pt", "Portuguese"),
101+
("ro", "Romanian"),
102+
("ru", "Russian"),
103+
("tr", "Turkish"),
104+
("uk", "Ukrainian")
105+
]
106+
107+
# -- Options for HTML output ---------------------------------------------------
108+
109+
html_theme = sconf.theme.name
110+
html_theme_path = [ os.path.join(conf.paths.buildsystem, 'themes') ]
111+
html_title = conf.project.title
112+
htmlhelp_basename = 'MongoDBdoc'
113+
114+
html_logo = ".static/logo-mongodb.png"
115+
html_static_path = ['source/.static']
116+
html_last_updated_fmt = '%b %d, %Y'
117+
118+
html_copy_source = False
119+
html_domain_indices = True
120+
html_use_index = True
121+
html_split_index = False
122+
html_show_sourcelink = False
123+
html_show_sphinx = True
124+
html_show_copyright = True
125+
126+
manual_edition_path = '{0}/{1}/{2}.{3}'
127+
128+
html_theme_options = {
129+
'branch': conf.git.branches.current,
130+
'translations': languages,
131+
'language': language,
132+
'manual_path': "ecosystem",
133+
'repo_name': 'docs-ecosystem',
134+
'jira_project': 'DOCS',
135+
'google_analytics': sconf.theme.google_analytics,
136+
'project': sconf.project,
137+
'nav_excluded': sconf.theme.nav_excluded,
138+
}
139+
140+
html_sidebars = sconf.sidebars

‎config/build_conf.yaml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
git:
2+
remote:
3+
upstream: 'mongodb/docs-realm'
4+
tools: 'mongodb/docs-tools'
5+
project:
6+
name: 'realm'
7+
tag: 'realm'
8+
url: 'http://docs.mongodb.com'
9+
title: "MongoDB Realm"
10+
branched: false
11+
system:
12+
tools:
13+
ref: HEAD
14+
pinned: false
15+
make:
16+
generated:
17+
- 'sphinx'
18+
- 'meta'
19+
- 'push'
20+
- 'migrations'
21+
- 'integration'
22+
static:
23+
- 'makefile.compatibility'
24+
- 'makefile.clean'
25+
files:
26+
- 'intersphinx.yaml'
27+
- 'push.yaml'
28+
- 'integration.yaml'
29+
- 'sphinx_local.yaml'
30+
- htaccess: ['htaccess.yaml']
31+
version:
32+
release: '2.6.4'
33+
branch: '2.6'
34+
assets:
35+
- branch: master
36+
path: build/docs-tools
37+
repository: http://github.com/mongodb/docs-tools.git
38+
- branch: ecosystem
39+
path: source/figures
40+
repository: http://github.com/mongodb/docs-assets.git
41+
paths:
42+
output: 'build'
43+
source: 'source'
44+
includes: 'source/includes'
45+
images: 'source/images'
46+
tools: 'bin'
47+
buildsystem: 'build/docs-tools'
48+
builddata: 'config'
49+
...

0 commit comments

Comments
 (0)