diff --git a/.evergreen/dailygreen.yml b/.evergreen/dailygreen.yml deleted file mode 100644 index ef046056e..000000000 --- a/.evergreen/dailygreen.yml +++ /dev/null @@ -1,74 +0,0 @@ -# Evergreen Project Config - -# When a task that used to pass starts to fail -# Go through all versions that may have been skipped to detect -# when the task started failing -stepback: true - -# Mark a failure as a system/bootstrap failure (purple box) rather then a task -# failure by default. -# Actual testing tasks are marked with `type: test` -command_type: system - -# Protect ourself against rogue test case, or curl gone wild, that runs forever -# 12 minutes is the longest we'll ever run -exec_timeout_secs: 3600 # 12 minutes is the longest we'll ever run - -# What to do when evergreen hits the timeout (`post:` tasks are run automatically) -timeout: - - command: shell.exec - params: - script: | - ls -la - -functions: - "fetch source": - - command: git.get_project - params: - directory: docs-ecosystem - - - "install checker tool": - - command: shell.exec - type: system - params: - shell: bash - working_dir: docs-ecosystem - script: | - export GOPATH=$(dirname $(dirname $(dirname `pwd`))) - export GOROOT='/opt/golang/go1.16' - export PATH=$GOROOT/bin:$GOPATH/bin/:$PATH - - go install github.com/terakilobyte/checker@latest - - - "run dialy": - - command: shell.exec - type: test - params: - shell: bash - working_dir: docs-ecosystem - script: | - export GOPATH=$(dirname $(dirname $(dirname `pwd`))) - export GOROOT='/opt/golang/go1.16' - export PATH=$GOROOT/bin:$GOPATH/bin/:$PATH - - checker --path . - -pre: - - func: "fetch source" - - func: "install checker tool" - -tasks: - - - name: check - commands: - - func: "run daily" - -buildvariants: - - - name: ubuntu2004 - display_name: Ubuntu 20.04 - run_on: [ ubuntu2004-large ] - tasks: - - name: check diff --git a/.evergreen/evergreen.yml b/.evergreen/evergreen.yml deleted file mode 100644 index a425b24a4..000000000 --- a/.evergreen/evergreen.yml +++ /dev/null @@ -1,74 +0,0 @@ -# Evergreen Project Config - -# When a task that used to pass starts to fail -# Go through all versions that may have been skipped to detect -# when the task started failing -stepback: true - -# Mark a failure as a system/bootstrap failure (purple box) rather then a task -# failure by default. -# Actual testing tasks are marked with `type: test` -command_type: system - -# Protect ourself against rogue test case, or curl gone wild, that runs forever -# 12 minutes is the longest we'll ever run -exec_timeout_secs: 3600 # 12 minutes is the longest we'll ever run - -# What to do when evergreen hits the timeout (`post:` tasks are run automatically) -timeout: - - command: shell.exec - params: - script: | - ls -la - -functions: - "fetch source": - - command: git.get_project - params: - directory: docs-ecosystem - - - "install checker tool": - - command: shell.exec - type: system - params: - shell: bash - working_dir: docs-ecosystem - script: | - export GOPATH=$(dirname $(dirname $(dirname `pwd`))) - export GOROOT='/opt/golang/go1.16' - export PATH=$GOROOT/bin:$GOPATH/bin/:$PATH - - go install github.com/terakilobyte/checker@latest - - - "run checker": - - command: shell.exec - type: test - params: - shell: bash - working_dir: docs-ecosystem - script: | - export GOPATH=$(dirname $(dirname $(dirname `pwd`))) - export GOROOT='/opt/golang/go1.16' - export PATH=$GOROOT/bin:$GOPATH/bin/:$PATH - - git diff --name-only HEAD master | tr "\n" "," | xargs checker --path . --changes - -pre: - - func: "fetch source" - - func: "install checker tool" - -tasks: - - - name: check - commands: - - func: "run checker" - -buildvariants: - - - name: ubuntu2004 - display_name: Ubuntu 20.04 - run_on: [ ubuntu2004-large ] - tasks: - - name: check diff --git a/.github/workflows/vale-tdbx.yml b/.github/workflows/vale-tdbx.yml index e8be8a922..483d4a9d1 100644 --- a/.github/workflows/vale-tdbx.yml +++ b/.github/workflows/vale-tdbx.yml @@ -12,23 +12,36 @@ jobs: - name: checkout uses: actions/checkout@master + - name: Install docutils + run: sudo apt-get install -y docutils + - id: files uses: masesgroup/retrieve-changed-files@v2 with: - format: 'csv' + format: "csv" - name: checkout-latest-rules uses: actions/checkout@master with: repository: mongodb/mongodb-vale-action - path: './tdbx-vale-rules' + path: "./tdbx-vale-rules" token: ${{secrets.GITHUB_TOKEN}} - name: move-files-for-vale-action run: | - cp tdbx-vale-rules/.vale.ini .vale.ini - mkdir -p .github/styles/ - cp -rf tdbx-vale-rules/.github/styles/ .github/ + cp tdbx-vale-rules/.vale.ini .vale.ini + mkdir -p .github/styles/ + cp -rf tdbx-vale-rules/.github/styles/ .github/ + + - if: steps.get_changed_files.outputs.all_changed_files != '' + uses: errata-ai/vale-action@reviewdog + with: + files: ${{steps.files.outputs.added_modified}} + separator: "," + filter_mode: diff_context + reporter: github-pr-review + fail_on_error: true + token: ${{ secrets.GITHUB_TOKEN }} - name: run-vale uses: errata-ai/vale-action@reviewdog diff --git a/.gitignore b/.gitignore deleted file mode 100644 index b3e7a15c5..000000000 --- a/.gitignore +++ /dev/null @@ -1,9 +0,0 @@ -*.swp -build/ -*pyc -source/images/* -DS_Store -.DS_Store -.#* -*.bak -source/kotlin.txt diff --git a/Makefile b/Makefile deleted file mode 100644 index 66bb730bd..000000000 --- a/Makefile +++ /dev/null @@ -1,44 +0,0 @@ -GIT_BRANCH=$(shell git rev-parse --abbrev-ref HEAD) -USER=$(shell whoami) -STAGING_URL="https://docs-mongodborg-staging.corp.mongodb.com" -PRODUCTION_URL="https://docs.mongodb.com/ecosystem" -STAGING_BUCKET=docs-mongodb-org-staging -PRODUCTION_BUCKET=docs-mongodb-org-prod - -# "PROJECT" currently exists to support having multiple projects -# within one bucket. -PROJECT=ecosystem - -.PHONY: help lint html stage deploy deploy-search-index - -help: ## Show this help message - @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}' - @echo - @echo 'Variables' - @printf " \033[36m%-18s\033[0m %s\n" 'ARGS' 'Arguments to pass to mut-publish' - -html: ## Builds this branch's HTML under build//html - giza make html - -publish: ## Builds this branch's publishable HTML and other artifacts under build/public - if [ ${GIT_BRANCH} = master ]; then rm -rf build/master build/public; fi - giza make publish - if [ ${GIT_BRANCH} = master ]; then mut-redirects config/redirects -o build/public/.htaccess; fi - -lint: ## Checks URLs in the built corpus underneath build//html - mut-lint --linters=links ./build/master/source/ ${ARGS} - -stage: ## Host online for review - mut-publish build/${GIT_BRANCH}/html ${STAGING_BUCKET} --prefix=${PROJECT} --stage ${ARGS} - @echo "Hosted at ${STAGING_URL}/${PROJECT}/${USER}/${GIT_BRANCH}/index.html" - -deploy: build/public ## Deploy to the production bucket - mut-publish build/public ${PRODUCTION_BUCKET} --prefix=${PROJECT} --deploy --redirect-prefix='ecosystem' --all-subdirectories ${ARGS} - - @echo "Hosted at ${PRODUCTION_URL}/index.html" - - $(MAKE) deploy-search-index - -deploy-search-index: ## Update the search index for this branch - @echo "Building search index" - mut-index upload build/public -o ${PROJECT}-${GIT_BRANCH}.json -u ${PRODUCTION_URL} -s diff --git a/conf-sitemap.xml b/conf-sitemap.xml deleted file mode 100644 index 30389e88d..000000000 --- a/conf-sitemap.xml +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - - - - - diff --git a/conf.py b/conf.py deleted file mode 100644 index 0e5336447..000000000 --- a/conf.py +++ /dev/null @@ -1,151 +0,0 @@ -# -*- coding: utf-8 -*- -# -# MongoDB documentation build configuration file, created by -# sphinx-quickstart on Mon Oct 3 09:58:40 2011. -# -# This file is execfile()d with the current directory set to its containing dir. - -from giza.config.helper import fetch_config, get_versions, get_manual_path -from giza.config.runtime import RuntimeStateConfig -import sys -import os.path -import datetime - -project_root = os.path.join(os.path.abspath(os.path.dirname(__file__))) -sys.path.append(project_root) - - -conf = fetch_config(RuntimeStateConfig()) -intersphinx_libs = conf.system.files.data.intersphinx -sconf = conf.system.files.data.sphinx_local - -sys.path.append(os.path.join(conf.paths.projectroot, - conf.paths.buildsystem, 'sphinxext')) - -# -- General configuration ---------------------------------------------------- - -needs_sphinx = '1.0' - - -extensions = [ - 'sphinx.ext.extlinks', - 'sphinx.ext.todo', - 'mongodb', - 'directives', - 'intermanual', - 'tabs', - 'fasthtml' -] - -templates_path = ['.templates'] -exclude_patterns = [] - -source_suffix = '.txt' - -master_doc = sconf.master_doc -language = 'en' -project = sconf.project -copyright = u'2008-{0}'.format(datetime.date.today().year) - -version = '3.0' -release = version - -rst_epilog = '\n'.join([ - '.. |branch| replace:: ``{0}``'.format(conf.git.branches.current), - '.. |copy| unicode:: U+000A9', - '.. |year| replace:: {0}'.format(datetime.date.today().year), - '.. |ent-build| replace:: MongoDB Enterprise', - '.. |hardlink| replace:: https://docs.mongodb.com/ecosystem/', - '.. |atlas-full| replace:: MongoDB Atlas', - '.. |atlas| replace:: Atlas' -]) - -extlinks = { - 'issue': ('https://jira.mongodb.org/browse/%s', ''), - 'api': ('https://api.mongodb.com/%s', ''), - 'manual': ('https://docs.mongodb.org/manual%s', ''), - 'spec': ('https://github.com/mongodb/specifications/blob/master/source%s', ''), - 'gettingstarted': ('https://docs.mongodb.org/getting-started%s', ''), - 'atlas': ('https://docs.atlas.mongodb.com%s', ''), - 'mms-home': ('https://www.mongodb.com/cloud/cloud-manager%s', ''), - 'guides': ('https://docs.mongodb.com/guides%s', ''), - 'java-docs': ('http://mongodb.github.io/mongo-java-driver/4.1/%s', ''), - 'kafka-21-javadoc': ('https://kafka.apache.org/21/javadoc/org/apache/kafka%s', ''), - 'csharp-docs': ('http://mongodb.github.io/mongo-csharp-driver/2.10%s', ''), - 'scala-docs': ('http://mongodb.github.io/mongo-scala-driver/2.9%s', ''), - 'aws-docs': ('https://docs.aws.amazon.com/%s', ''), - 'wikipedia': ('https://en.wikipedia.org/wiki/%s', ''), - 'community-support': ('https://www.mongodb.com/community-support-resources%s', ''), - 'technical-support': ('https://docs.mongodb.com/manual/support%s', ''), - 'community-forum': ('https://community.mongodb.com/%s', ''), -} - -intersphinx_mapping = {} - -try: - for i in intersphinx_libs: - intersphinx_mapping[i['name']] = (i['url'], os.path.join(conf.paths.projectroot, - conf.paths.output, - i['path'])) -except: - for i in intersphinx_libs: - intersphinx_mapping[i.name] = (i.url, os.path.join(conf.paths.projectroot, - conf.paths.output, - i.path)) - - -languages = [ - ("ar", "Arabic"), - ("cn", "Chinese"), - ("cs", "Czech"), - ("de", "German"), - ("es", "Spanish"), - ("fr", "French"), - ("hu", "Hungarian"), - ("id", "Indonesian"), - ("it", "Italian"), - ("jp", "Japanese"), - ("ko", "Korean"), - ("lt", "Lithuanian"), - ("pl", "Polish"), - ("pt", "Portuguese"), - ("ro", "Romanian"), - ("ru", "Russian"), - ("tr", "Turkish"), - ("uk", "Ukrainian") -] - -# -- Options for HTML output --------------------------------------------------- - -html_theme = sconf.theme.name -html_theme_path = [os.path.join(conf.paths.buildsystem, 'themes')] -html_title = conf.project.title -htmlhelp_basename = 'MongoDBdoc' - -html_logo = ".static/logo-mongodb.png" -html_static_path = ['source/.static'] -html_last_updated_fmt = '%b %d, %Y' - -html_copy_source = False -html_domain_indices = True -html_use_index = True -html_split_index = False -html_show_sourcelink = False -html_show_sphinx = True -html_show_copyright = True - -manual_edition_path = '{0}/{1}/{2}.{3}' - -html_theme_options = { - 'branch': conf.git.branches.current, - 'translations': languages, - 'language': language, - 'manual_path': "ecosystem", - 'repo_name': 'docs-ecosystem', - 'jira_project': 'DOCS', - 'google_analytics': sconf.theme.google_analytics, - 'project': sconf.project, - 'nav_excluded': sconf.theme.nav_excluded, -} - -html_sidebars = sconf.sidebars diff --git a/config/build_conf.yaml b/config/build_conf.yaml deleted file mode 100644 index 5a8156cb2..000000000 --- a/config/build_conf.yaml +++ /dev/null @@ -1,49 +0,0 @@ -git: - remote: - upstream: 'mongodb/docs-ecosystem' - tools: 'mongodb/docs-tools' -project: - name: 'ecosystem' - tag: 'ecosystem' - url: 'http://docs.mongodb.com' - title: "MongoDB Ecosystem" - branched: false -system: - tools: - ref: HEAD - pinned: false - make: - generated: - - 'sphinx' - - 'meta' - - 'push' - - 'migrations' - - 'integration' - static: - - 'makefile.compatibility' - - 'makefile.clean' - files: - - 'intersphinx.yaml' - - 'push.yaml' - - 'integration.yaml' - - 'sphinx_local.yaml' - - htaccess: ['htaccess.yaml'] -version: - release: '2.6.4' - branch: '2.6' -assets: - - branch: master - path: build/docs-tools - repository: http://github.com/mongodb/docs-tools.git - - branch: ecosystem - path: source/figures - repository: http://github.com/mongodb/docs-assets.git -paths: - output: 'build' - source: 'source' - includes: 'source/includes' - images: 'source/images' - tools: 'bin' - buildsystem: 'build/docs-tools' - builddata: 'config' -... diff --git a/config/htaccess.yaml b/config/htaccess.yaml deleted file mode 100644 index 6450dae28..000000000 --- a/config/htaccess.yaml +++ /dev/null @@ -1,443 +0,0 @@ -from: '/tutorial/install-mongodb-on-amazon-ec2' -to: '/platforms/amazon-ec2' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/tutorial/automate-deployment-with-cloudformation' -to: '/platforms/amazon-ec2' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/tutorial/deploy-mongodb-from-aws-marketplace' -to: '/platforms/amazon-ec2' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/tutorial/install-mongodb-on-windows-azure' -to: '/platforms/windows-azure' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/tutorials' -to: '/tutorial' -type: 'redirect' -code: 303 -outputs: - - 'ecosystem' ---- -from: /drivers/javascript -to: /drivers/node-js -code: 303 -outputs: ['ecosystem'] -type: redirect ---- -from: '/tutorial/download-and-compile-cpp-driver' -to: '/Download%20and%20Compile' -code: 303 -outputs: - - { 'ecosystem': 'https://github.com/mongodb/mongo-cxx-driver/wiki'} ---- -from: '/tutorial/getting-started-with-cpp-driver' -to: '/blob/legacy/README.md' -code: 303 -outputs: - - { 'ecosystem': 'https://github.com/mongodb/mongo-cxx-driver/wiki'} ---- -from: '/drivers/cpp-bson-array-examples' -to: '/blob/legacy/src/mongo/client/examples/arrayExample.cpp' -code: 303 -outputs: - - { 'ecosystem' : 'https://github.com/mongodb/mongo-cxx-driver/wiki' } ---- -from: "/drivers/cpp-bson-helper-functions" -to: "/BSON%20Helper%20Functions" -code: 303 -outputs: - - { 'ecosystem' : 'https://github.com/mongodb/mongo-cxx-driver/wiki' } ---- -from: "/drivers/cpp-to-sql-to-mongo-shell" -to: "/" -code: 303 -outputs: - - { 'ecosystem' : 'https://github.com/mongodb/mongo-cxx-driver/wiki' } ---- -from: '/tools/administration-interfaces' -to: '/tools' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/tutorial/configure-worker-roles-in-azure' -to: '/platforms/windows-azure' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/tutorial/deploy-mongodb-worker-roles-in-azure-version-1-6' -to: '/platforms/windows-azure' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/tutorial/deploy-mongodb-worker-roles-in-azure' -to: '/platforms/windows-azure' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/tutorial/build-an-application-to-connect-to-mongodb-on-azure' -to: '/platforms/windows-azure' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: /tutorial/use-java-dbobject-to-perform-saves -to: /drivers/java -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: /drivers/java-concurrency -to: /3.0/driver/reference/crud -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-java-driver'} ---- -from: /drivers/java-replica-set-semantics -to: /3.0/driver/reference/crud -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-java-driver'} ---- -from: /drivers/java-types -to: /3.0/bson -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-java-driver'} ---- -from: /tutorial/getting-started-with-3.0-java-driver -to: /3.0/driver/getting-started/quick-tour/ -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-java-driver'} ---- -from: /tutorial/getting-started-with-java-driver -to: /2.13/getting-started/quick-tour -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-java-driver'} ---- -from: /tutorial/use-aggregation-framework-with-java-driver -to: /3.0/driver/getting-started/quick-tour/ -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-java-driver'} ---- -from: /drivers/csharp-community-projects -to: /drivers/csharp -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: /tutorial/authenticate-with-csharp-driver -to: /2.2/reference/driver/authentication/ -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-csharp-driver'} ---- -from: /tutorial/getting-started-with-csharp-driver -to: /2.2/getting_started -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-csharp-driver'} ---- -from: /tutorial/serialize-documents-with-the-csharp-driver -to: /2.2/getting_started -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-csharp-driver'} ---- -from: /tutorial/use-csharp-driver -to: /2.2/getting_started -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-csharp-driver'} ---- -from: /tutorial/use-linq-queries-with-csharp-driver -to: /2.2/getting_started -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-csharp-driver'} ---- -from: /tutorial/getting-started-with-ruby-on-rails-3 -to: /tutorial/ruby-bson-tutorial -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: /tutorial/getting-started-with-ruby-on-rails -to: /tutorial/ruby-bson-tutorial -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: /tutorial/joyent-cloud -to: /platforms -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: /tutorial/authenticate-with-java-driver/ -to: /3.0/driver/reference/connecting/authenticating/ -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-java-driver'} ---- -from: '/tutorial/install-mongodb-on-linux-in-azure' -to: '/platforms/windows-azure' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/tutorial/model-data-for-ruby-on-rails' -to: '/drivers/ruby' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: /tools/applications -to: /deployments -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://www.mongodb.com/community'} ---- -from: /tutorial/download-and-compile-cpp-driver-legacy -to: /Download-and-Compile-the-Legacy-Driver -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://github.com/mongodb/mongo-cxx-driver/wiki'} ---- -from: '/drivers/ruby' -to: '/master' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/drivers/ruby-resources' -to: '/master/reference/additional-resources' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/ruby-driver-tutorial' -to: '/v2.2' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/ruby-driver-tutorial-2-0' -to: '/v2.0' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/ruby-bson-tutorial' -to: '/master/tutorials/bson-v3/' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/ruby-bson-tutorial-4-0' -to: '/master/tutorials/bson-v4/' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/ruby-mongoid-tutorial' -to: '/master/mongoid-tutorials' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-callbacks' -to: '/master/tutorials/mongoid-callbacks' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-documents' -to: '/master/tutorials/mongoid-documents' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-indexes' -to: '/master/tutorials/mongoid-indexes' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-installation' -to: '/master/tutorials/mongoid-installation' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-nested-attributes' -to: '/master/tutorials/mongoid-nested-attributes' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-persistence' -to: '/master/tutorials/mongoid-persistence' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-queries' -to: '/master/tutorials/mongoid-queries' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-rails' -to: '/master/tutorials/mongoid-rails' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-relations' -to: '/master/tutorials/mongoid-relations' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-upgrade' -to: '/master/tutorials/mongoid-upgrade' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/tutorial/mongoid-validation' -to: '/master/tutorials/mongoid-validation' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://docs.mongodb.com/ruby-driver'} ---- -from: '/drivers/downloads' -to: '/drivers' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/tutorial/write-a-tumblelog-application-with-flask-mongoengine' -to: '/getting-started.html' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://pymodm.readthedocs.io/en/latest'} ---- -from: '/drivers/node-js' -to: '/' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://mongodb.github.io/node-mongodb-native'} ---- -from: '/drivers/c' -to: '/' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongoc.org/'} ---- -from: '/use-cases/pre-aggregated-reports' -to: '/use-cases/pre-aggregated-reports-mmapv1' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/drivers/cpp' -to: '/' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://mongodb.github.io/mongo-cxx-driver/'} ---- -from: '/tutorial/authenticate-with-cpp-driver' -to: '/' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'https://mongodb.github.io/mongo-cxx-driver/'} ---- -from: '/drivers/perl-internals' -to: '/drivers/perl' -type: 'redirect' -code: 301 -outputs: - - 'ecosystem' ---- -from: '/drivers/java' -to: '/' -type: 'redirect' -code: 301 -outputs: - - {'ecosystem': 'http://mongodb.github.io/mongo-java-driver/'} - -... diff --git a/config/integration.yaml b/config/integration.yaml deleted file mode 100644 index 0a87b6961..000000000 --- a/config/integration.yaml +++ /dev/null @@ -1,20 +0,0 @@ -fr: - inherit: base -es: - inherit: base -ja: - inherit: base -zh: - inherit: base -it: - inherit: base -base: - links: [] - targets: - - html - - dirhtml - doc-root: - - '' - - '.htaccess' - branch-root: null -... \ No newline at end of file diff --git a/config/intersphinx.yaml b/config/intersphinx.yaml deleted file mode 100644 index 91a45ac44..000000000 --- a/config/intersphinx.yaml +++ /dev/null @@ -1,8 +0,0 @@ -name: mongodb -url: https://docs.mongodb.com/manual/ -path: mongodb.inv ---- -name: pymongo -url: http://api.mongodb.com/python/current/ -path: pymongo.inv -... diff --git a/config/migrations.yaml b/config/migrations.yaml deleted file mode 100644 index bfbddc51f..000000000 --- a/config/migrations.yaml +++ /dev/null @@ -1,40 +0,0 @@ -target: - - sitemap - - $(public-output)/sitemap.xml.gz -dependency: - - $(public-output) - - html -command: "fab generate.sitemap" -message: "[sitemap]: sitemap build complete at `date`." -action: cmd ---- -target: setup -command: '-bin/images-setup' -action: cmd -message: "[build]: initialzed images if possible. optional" ---- -target: '$(branch-output)/dirhtml' -dependency: 'dirhtml' -action: 'touch' ---- -target: '$(public-output)' -dependency: '$(branch-output)/dirhtml' -action: 'transfer' ---- -target: - - htaccess - - $(public-output)/.htaccess -dependency: - - config/htaccess.yaml - - $(tools)/bin/htaccess.py -command: "fab generate.htaccess:$(public-output)/.htaccess" -action: cmd ---- -target: '.PHONY' -dependency: - - publish - - setup - - sitemap - - htaccess -action: dep -... diff --git a/config/pdfs.yaml b/config/pdfs.yaml deleted file mode 100644 index 47e8f4530..000000000 --- a/config/pdfs.yaml +++ /dev/null @@ -1,7 +0,0 @@ -source: 'contents' -title: 'MongoDB Ecosystem Documentation' -output: 'MongoDB-Ecosystem.tex' -author: 'MongoDB, Inc.' -class: 'manual' -tag: 'guide' -... diff --git a/config/push.yaml b/config/push.yaml deleted file mode 100644 index 9f15405a4..000000000 --- a/config/push.yaml +++ /dev/null @@ -1,34 +0,0 @@ -target: push -paths: - remote: /data/sites/docs/ecosystem - local: public - static: ['.htaccess'] -options: ['recursive'] -env: publication -dependency: push-if-up-to-date ---- -target: push-with-delete -paths: - remote: /data/sites/docs/ecosystem - local: public - static: ['.htaccess'] -options: ['delete', 'recursive'] -env: publication -dependency: publish ---- -target: stage -paths: - remote: /srv/public/test/ecosystem - local: public -options: ['recursive'] -env: staging -dependency: stage-if-up-to-date ---- -target: stage-with-delete -paths: - remote: /srv/public/test/ecosystem - local: public -options: ['delete', 'recursive'] -env: staging -dependency: publish -... diff --git a/config/robots.yaml b/config/robots.yaml deleted file mode 100644 index c59a500a5..000000000 --- a/config/robots.yaml +++ /dev/null @@ -1,4 +0,0 @@ -file: '/meta/google-compute-engine' -branches: - - 'ecosystem' -... \ No newline at end of file diff --git a/config/sphinx.yaml b/config/sphinx.yaml deleted file mode 100644 index cbd0b57ed..000000000 --- a/config/sphinx.yaml +++ /dev/null @@ -1,41 +0,0 @@ -# The items in the ``builders`` list are the name of Sphinx builders -# supported by ``sphinx-build``. -# -# The ``prerequsites`` list stores all targets that must build before -# sphinx can begin. -# -# The ``generated-source`` list stores all the targets that generate rst. - -builders: - - dirhtml - - singlehtml - - html - - gettext - - changes - - doctest - - linkcheck - - texinfo -prerequisites: - - setup - - intersphinx - - generate-source -generated-source: - - tables -### --- #### -web-base: - tags: - - web -print-base: - tags: - - print -### --- #### -dirhtml: - builder: dirhtml - inherit: web-base -html: - builder: html - inherit: web-base -singlehtml: - builder: singlehtml - inherit: web-base -... \ No newline at end of file diff --git a/config/sphinx_local.yaml b/config/sphinx_local.yaml deleted file mode 100644 index 60a5f03f8..000000000 --- a/config/sphinx_local.yaml +++ /dev/null @@ -1,26 +0,0 @@ -project: 'ecosystem' -master_doc: 'contents' -paths: - static: ['source/.static'] -theme: - name: 'ecosystem' - sitename: 'MongoDB Ecosystem' - jira: 'DOCS' - google_analytics: 'UA-7301842-8' - nav_excluded: - - /drivers - - /drivers/c - - /drivers/cpp - - /drivers/csharp - - /drivers/go - - /drivers/erlang - - /drivers/node-js - - /drivers/perl - - /drivers/php - - /drivers/python - - /drivers/ruby - - /drivers/scala -sidebars: - '**': - - 'pagenav.html' -... diff --git a/source/.static/.mongodb b/source/.static/.mongodb deleted file mode 100644 index e69de29bb..000000000 diff --git a/source/figures/M220JS_hero.jpg b/source/figures/M220JS_hero.jpg deleted file mode 100644 index 38905b9b0..000000000 Binary files a/source/figures/M220JS_hero.jpg and /dev/null differ diff --git a/source/includes/attention-docs-eol.rst b/source/includes/attention-docs-eol.rst deleted file mode 100644 index 305c3686b..000000000 --- a/source/includes/attention-docs-eol.rst +++ /dev/null @@ -1,2 +0,0 @@ -.. warning:: - This documentation is no longer maintained. diff --git a/source/includes/connection-snippets/scram/c-connection-no-stable-api.c b/source/includes/connection-snippets/scram/c-connection-no-stable-api.c deleted file mode 100644 index e53b93f5c..000000000 --- a/source/includes/connection-snippets/scram/c-connection-no-stable-api.c +++ /dev/null @@ -1,52 +0,0 @@ -#include - -int main(void) { - mongoc_client_t *client = NULL; - bson_error_t error = {0}; - mongoc_database_t *database = NULL; - bson_t *command = NULL; - bson_t reply = BSON_INITIALIZER; - int rc = 0; - bool ok = true; - - // Initialize the MongoDB C Driver. - mongoc_init(); - - client = mongoc_client_new(""); - if (!client) { - fprintf(stderr, "Failed to create a MongoDB client.\n"); - rc = 1; - goto cleanup; - } - - // Get a handle on the "admin" database. - database = mongoc_client_get_database(client, "admin"); - if (!database) { - fprintf(stderr, "Failed to get a MongoDB database handle.\n"); - rc = 1; - goto cleanup; - } - - // Ping the database. - command = BCON_NEW("ping", BCON_INT32(1)); - ok = mongoc_database_command_simple( - database, command, NULL, &reply, &error - ); - if (!ok) { - fprintf(stderr, "error: %s\n", error.message); - rc = 1; - goto cleanup; - } - bson_destroy(&reply); - - printf("Pinged your deployment. You successfully connected to MongoDB!\n"); - -// Perform cleanup. -cleanup: - bson_destroy(command); - mongoc_database_destroy(database); - mongoc_client_destroy(client); - mongoc_cleanup(); - - return rc; -} \ No newline at end of file diff --git a/source/includes/connection-snippets/scram/c-connection.c b/source/includes/connection-snippets/scram/c-connection.c deleted file mode 100644 index a2c651c26..000000000 --- a/source/includes/connection-snippets/scram/c-connection.c +++ /dev/null @@ -1,69 +0,0 @@ -#include - -int main(void) { - mongoc_client_t *client = NULL; - bson_error_t error = {0}; - mongoc_server_api_t *api = NULL; - mongoc_database_t *database = NULL; - bson_t *command = NULL; - bson_t reply = BSON_INITIALIZER; - int rc = 0; - bool ok = true; - - // Initialize the MongoDB C Driver. - mongoc_init(); - - client = mongoc_client_new(""); - if (!client) { - fprintf(stderr, "Failed to create a MongoDB client.\n"); - rc = 1; - goto cleanup; - } - - // Set the version of the Stable API on the client. - api = mongoc_server_api_new(MONGOC_SERVER_API_V1); - if (!api) { - fprintf(stderr, "Failed to create a MongoDB server API.\n"); - rc = 1; - goto cleanup; - } - - ok = mongoc_client_set_server_api(client, api, &error); - if (!ok) { - fprintf(stderr, "error: %s\n", error.message); - rc = 1; - goto cleanup; - } - - // Get a handle on the "admin" database. - database = mongoc_client_get_database(client, "admin"); - if (!database) { - fprintf(stderr, "Failed to get a MongoDB database handle.\n"); - rc = 1; - goto cleanup; - } - - // Ping the database. - command = BCON_NEW("ping", BCON_INT32(1)); - ok = mongoc_database_command_simple( - database, command, NULL, &reply, &error - ); - if (!ok) { - fprintf(stderr, "error: %s\n", error.message); - rc = 1; - goto cleanup; - } - bson_destroy(&reply); - - printf("Pinged your deployment. You successfully connected to MongoDB!\n"); - -// Perform cleanup. -cleanup: - bson_destroy(command); - mongoc_database_destroy(database); - mongoc_server_api_destroy(api); - mongoc_client_destroy(client); - mongoc_cleanup(); - - return rc; -} \ No newline at end of file diff --git a/source/includes/connection-snippets/scram/cxx-connection-no-stable-api.cpp b/source/includes/connection-snippets/scram/cxx-connection-no-stable-api.cpp deleted file mode 100644 index 8083cd0cd..000000000 --- a/source/includes/connection-snippets/scram/cxx-connection-no-stable-api.cpp +++ /dev/null @@ -1,31 +0,0 @@ -#include -#include -#include - -int main() -{ - try - { - // Create an instance. - mongocxx::instance inst{}; - - // Replace the connection string with your MongoDB deployment's connection string. - const auto uri = mongocxx::uri{""}; - - // Setup the connection and get a handle on the "admin" database. - mongocxx::client conn{ uri }; - mongocxx::database db = conn["admin"]; - - // Ping the database. - const auto ping_cmd = bsoncxx::builder::basic::make_document(bsoncxx::builder::basic::kvp("ping", 1)); - db.run_command(ping_cmd.view()); - std::cout << "Pinged your deployment. You successfully connected to MongoDB!" << std::endl; - } - catch (const std::exception& e) - { - // Handle errors. - std::cout<< "Exception: " << e.what() << std::endl; - } - - return 0; -} diff --git a/source/includes/connection-snippets/scram/cxx-connection.cpp b/source/includes/connection-snippets/scram/cxx-connection.cpp deleted file mode 100644 index 8dab807e7..000000000 --- a/source/includes/connection-snippets/scram/cxx-connection.cpp +++ /dev/null @@ -1,36 +0,0 @@ -#include -#include -#include - -int main() -{ - try - { - // Create an instance. - mongocxx::instance inst{}; - - // Replace the connection string with your MongoDB deployment's connection string. - const auto uri = mongocxx::uri{""}; - - // Set the version of the Stable API on the client. - mongocxx::options::client client_options; - const auto api = mongocxx::options::server_api{ mongocxx::options::server_api::version::k_version_1 }; - client_options.server_api_opts(api); - - // Setup the connection and get a handle on the "admin" database. - mongocxx::client conn{ uri, client_options }; - mongocxx::database db = conn["admin"]; - - // Ping the database. - const auto ping_cmd = bsoncxx::builder::basic::make_document(bsoncxx::builder::basic::kvp("ping", 1)); - db.run_command(ping_cmd.view()); - std::cout << "Pinged your deployment. You successfully connected to MongoDB!" << std::endl; - } - catch (const std::exception& e) - { - // Handle errors. - std::cout<< "Exception: " << e.what() << std::endl; - } - - return 0; -} diff --git a/source/includes/connection-snippets/scram/pymongo-connection-no-stableapi.py b/source/includes/connection-snippets/scram/pymongo-connection-no-stableapi.py deleted file mode 100644 index a7bb23d4c..000000000 --- a/source/includes/connection-snippets/scram/pymongo-connection-no-stableapi.py +++ /dev/null @@ -1,14 +0,0 @@ -from pymongo.mongo_client import MongoClient - -# Replace the placeholder with your Atlas connection string -uri = "" - -# Create a new client and connect to the server -client = MongoClient(uri) - -# Send a ping to confirm a successful connection -try: - client.admin.command('ping') - print("Pinged your deployment. You successfully connected to MongoDB!") -except Exception as e: - print(e) \ No newline at end of file diff --git a/source/includes/connection-snippets/scram/pymongo-connection.py b/source/includes/connection-snippets/scram/pymongo-connection.py deleted file mode 100644 index 17f491ac9..000000000 --- a/source/includes/connection-snippets/scram/pymongo-connection.py +++ /dev/null @@ -1,15 +0,0 @@ -from pymongo.mongo_client import MongoClient -from pymongo.server_api import ServerApi - -# Replace the placeholder with your Atlas connection string -uri = "" - -# Set the Stable API version when creating a new client -client = MongoClient(uri, server_api=ServerApi('1')) - -# Send a ping to confirm a successful connection -try: - client.admin.command('ping') - print("Pinged your deployment. You successfully connected to MongoDB!") -except Exception as e: - print(e) \ No newline at end of file diff --git a/source/includes/connection-snippets/x509-snippets/c-connection.c b/source/includes/connection-snippets/x509-snippets/c-connection.c deleted file mode 100644 index 6bc0b1a0c..000000000 --- a/source/includes/connection-snippets/x509-snippets/c-connection.c +++ /dev/null @@ -1,36 +0,0 @@ -// begin x509 connection -#include -#include - -int main(int argc, char *argv[]) { - mongoc_collection_t *collection; - mongoc_client_t *client; - int64_t count; - bson_t filter; - bson_error_t error; - - mongoc_init(); - - client = mongoc_client_new( - "mongodb+srv:///" - "test?authSource=$external&tlsCertificateKeyFile=/etc/certs/mongodb/" - "client.pem&retryWrites=true&w=majority&authMechanism=MONGODB-X509"); - - collection = mongoc_client_get_collection(client, "testDB", "testCol"); - filter = BSON_INITIALIZER; - count = mongoc_collection_count_documents(collection, &filter, NULL, NULL, - NULL, &error); - - if (count < 0) { - fprintf(stderr, "Count failed: %s\n", error.message); - } else { - printf("%" PRId64 " documents counted.\n", count); - } - bson_destroy(&filter); - mongoc_collection_destroy(collection); - mongoc_client_destroy(client); - mongoc_cleanup(); - - return 0; -} -// end x509 connection \ No newline at end of file diff --git a/source/includes/connection-snippets/x509-snippets/cpp-connection.cpp b/source/includes/connection-snippets/x509-snippets/cpp-connection.cpp deleted file mode 100644 index eb14a95a0..000000000 --- a/source/includes/connection-snippets/x509-snippets/cpp-connection.cpp +++ /dev/null @@ -1,25 +0,0 @@ -// begin x509 connection -#include -#include -#include -#include -#include - -int main(int, char**) { - mongocxx::instance inst{}; - - mongocxx::options::ssl ssl_opts{}; - ssl_opts.pem_file("/etc/certs/mongodb/client.pem"); - - mongocxx::options::client client_opts{}; - client_opts.ssl_opts(ssl_opts); - - mongocxx::uri uri("mongodb+srv:///test?authSource=$external&retryWrites=true&w=majority&authMechanism=MONGODB-X509&tls=true"); - - auto client = mongocxx::client{uri, client_opts}; - mongocxx::database db = client["testDB"]; - mongocxx::collection collection = db["testCol"]; - - std::cout << collection.count_documents({}); -} -// end x509 connection \ No newline at end of file diff --git a/source/includes/connection-snippets/x509-snippets/csharp-connection.cs b/source/includes/connection-snippets/x509-snippets/csharp-connection.cs deleted file mode 100644 index 90ee0b03e..000000000 --- a/source/includes/connection-snippets/x509-snippets/csharp-connection.cs +++ /dev/null @@ -1,51 +0,0 @@ -// begin x509 connection -using MongoDB.Bson; -using MongoDB.Driver; -using System; -using System.IO; -using System.Threading.Tasks; -using System.Collections.Generic; -using System.Security.Cryptography.X509Certificates; - -// Tested using MongoDB.Driver 2.9.2 and netcoreapp 2.2 - -namespace WorkingWithMongoDB -{ - class Program - { - static void Main(string[] args) - { - MainAsync().Wait(); - } - - static async Task MainAsync() - { - var connectionString = "mongodb+srv:///test?authSource=$external&retryWrites=true&w=majority&authMechanism=MONGODB-X509"; - var settings = MongoClientSettings.FromConnectionString(connectionString); - - // You will need to convert your Atlas-provided PEM containing the cert/private keys into a PFX - // use openssl and the following line to create a PFX from your PEM: - // openssl pkcs12 -export -in .pem -inkey .pem -out .pfx -certfile .pem - // and provide a password, which should match the second argument you pass to X509Certificate2 - var cert = new X509Certificate2("/etc/certs/mongodb/client-certificate.pfx", ""); - - settings.SslSettings = new SslSettings - { - ClientCertificates = new List() - { - cert - } - }; - - var client = new MongoClient(settings); - - // just doing a quick read to verify the usability of this connection - var database = client.GetDatabase("testDB"); - var collection = database.GetCollection("testCol"); - - var docCount = collection.CountDocuments("{}"); - Console.WriteLine(docCount); - } - } -} -// end x509 connection \ No newline at end of file diff --git a/source/includes/connection-snippets/x509-snippets/go-connection.go b/source/includes/connection-snippets/x509-snippets/go-connection.go deleted file mode 100644 index 947ae30bb..000000000 --- a/source/includes/connection-snippets/x509-snippets/go-connection.go +++ /dev/null @@ -1,29 +0,0 @@ -// begin x509 connection -package main - -import ( - "context" - "fmt" - "log" - "go.mongodb.org/mongo-driver/mongo" - "go.mongodb.org/mongo-driver/mongo/options" - "go.mongodb.org/mongo-driver/bson" -) - -func main() { - ctx := context.TODO() - certificateKeyFilePath := "/etc/certs/mongodb/client.pem" - uri := "mongodb+srv:///test?authSource=$external&tlsCertificateKeyFile=%s&retryWrites=true&w=majority&authMechanism=MONGODB-X509" - uri = fmt.Sprintf(uri, certificateKeyFilePath) - clientOpts := options.Client().ApplyURI(uri) - - client, err := mongo.Connect(ctx, clientOpts) - if err != nil { log.Fatal(err) } - defer client.Disconnect(ctx) - - collection := client.Database("testDB").Collection("testCol") - docCount, err := collection.CountDocuments(ctx, bson.D{}) - if err != nil { log.Fatal(err) } - fmt.Println(docCount) -} -// end x509 connection \ No newline at end of file diff --git a/source/includes/connection-snippets/x509-snippets/java-connection.java b/source/includes/connection-snippets/x509-snippets/java-connection.java deleted file mode 100644 index 1438ebe4a..000000000 --- a/source/includes/connection-snippets/x509-snippets/java-connection.java +++ /dev/null @@ -1,27 +0,0 @@ - -// begin x509 connection -import com.mongodb.client.MongoClient; -import com.mongodb.client.MongoClients; -import com.mongodb.client.MongoDatabase; -import com.mongodb.client.MongoCollection; -import org.bson.Document; -import org.bson.BsonDocument; - -public class X509Connection { - - public static void main(String args[]) { - // Set system properties via commandline or programmatically - System.setProperty("javax.net.ssl.keyStore", "/etc/certs/mongodb/v3/client.keystore"); - System.setProperty("javax.net.ssl.keyStorePassword", ""); - - String uri = "mongodb+srv:///test?authMechanism=MONGODB-X509&authSource=$external&retryWrites=true&w=majority"; - MongoClient client = MongoClients.create(uri); - MongoDatabase database = mongoClient.getDatabase("testDB"); - MongoCollection collection = database.getCollection("testCol"); - BsonDocument filter = new BsonDocument(); - collection.countDocuments(filter); - - client.close(); - } -} -// end x509 connection \ No newline at end of file diff --git a/source/includes/connection-snippets/x509-snippets/node-connection.js b/source/includes/connection-snippets/x509-snippets/node-connection.js deleted file mode 100644 index be1fadd2b..000000000 --- a/source/includes/connection-snippets/x509-snippets/node-connection.js +++ /dev/null @@ -1,27 +0,0 @@ -// begin x509 connection -const { MongoClient } = require('mongodb'); -const fs = require('fs'); - -const credentials = fs.readFileSync('/etc/certs/mongodb/client.pem'); - -const client = new MongoClient('mongodb+srv:///test?authSource=$external&retryWrites=true&w=majority&authMechanism=MONGODB-X509', { - sslKey: credentials, - sslCert: credentials -}); - -async function run() { - try { - await client.connect(); - const database = client.db("testDB"); - const collection = database.collection("testCol"); - const docCount = await collection.countDocuments({}); - console.log(docCount); - // perform actions using client - } finally { - // Ensures that the client will close when you finish/error - await client.close(); - } -} - -run().catch(console.dir); -// end x509 connection \ No newline at end of file diff --git a/source/includes/connection-snippets/x509-snippets/php-connection.php b/source/includes/connection-snippets/x509-snippets/php-connection.php deleted file mode 100644 index 19bfadc59..000000000 --- a/source/includes/connection-snippets/x509-snippets/php-connection.php +++ /dev/null @@ -1,10 +0,0 @@ -/test?authSource=$external&tlsCertificateKeyFile=' . $certificateKeyFilePath . '&retryWrites=true&w=majority&authMechanism=MONGODB-X509' -); -$collection = $client->testDB->testCol; -$docCount = $collection->countDocuments(); -echo $docCount, "\n"; -/* End x509 connection */ \ No newline at end of file diff --git a/source/includes/connection-snippets/x509-snippets/python-connection.py b/source/includes/connection-snippets/x509-snippets/python-connection.py deleted file mode 100644 index 4ab13ad4b..000000000 --- a/source/includes/connection-snippets/x509-snippets/python-connection.py +++ /dev/null @@ -1,13 +0,0 @@ -# begin x509 connection -from pymongo import MongoClient - -uri = "mongodb+srv:///test?authSource=$external&retryWrites=true&w=majority&authMechanism=MONGODB-X509" -client = MongoClient(uri, - tls=True, - tlsCertificateKeyFile='/etc/certs/mongodb/client.pem') - -db = client['testDB'] -collection = db['testCol'] -doc_count = collection.count_documents({}) -print(doc_count) -# end x509 connection diff --git a/source/includes/connection-snippets/x509-snippets/ruby-connection.rb b/source/includes/connection-snippets/x509-snippets/ruby-connection.rb deleted file mode 100644 index ca13e4bcc..000000000 --- a/source/includes/connection-snippets/x509-snippets/ruby-connection.rb +++ /dev/null @@ -1,11 +0,0 @@ -# begin x509 connection -require 'mongo' -certificate_key_file_path = '/etc/certs/mongodb/client.pem' -uri = 'mongodb+srv:///test?authSource=$external&tlsCertificateKeyFile=' + certificate_key_file_path + '&retryWrites=true&w=majority&authMechanism=MONGODB-X509' - -client = Mongo::Client.new([ uri ], :database => 'testDB') - -collection = client[:testCol] -doc_count = collection.count_documents({}) -print doc_count -# end x509 connection diff --git a/source/includes/driver-compatibility-caveat.rst b/source/includes/driver-compatibility-caveat.rst deleted file mode 100644 index 1da5d4293..000000000 --- a/source/includes/driver-compatibility-caveat.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. note:: - - The compatibility matrices show which versions of the driver are - recommended for use with a given major release. Older driver versions - may be able to connect to a version of MongoDB which is not - recommended for that driver version; however, not all - server features will be available. diff --git a/source/includes/language-compatibility-table-cxx.rst b/source/includes/language-compatibility-table-cxx.rst deleted file mode 100644 index fc3bfd94f..000000000 --- a/source/includes/language-compatibility-table-cxx.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. list-table:: - :header-rows: 1 - :stub-columns: 1 - :class: compatibility - - * - C++ Driver Version - - C++20 - - C++17 - - C++14 - - C++11 - - C++03 - - * - 3.8+ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - <= 3.7 - - - - ✓ - - ✓ - - ✓ - - - - * - 1.x - - - - - - ✓ - - ✓ - - ✓ diff --git a/source/includes/language-compatibility-table-php.rst b/source/includes/language-compatibility-table-php.rst deleted file mode 100644 index bea0bde60..000000000 --- a/source/includes/language-compatibility-table-php.rst +++ /dev/null @@ -1,244 +0,0 @@ -.. Full compatibility table, for reference only. - -.. list-table:: - :header-rows: 1 - :stub-columns: 1 - :class: compatibility-large - - * - PHP Driver Versions - - PHP 8.4 - - PHP 8.3 - - PHP 8.2 - - PHP 8.1 - - PHP 8.0 - - PHP 7.4 - - PHP 7.3 - - PHP 7.2 - - PHP 7.1 - - PHP 7.0 - - PHP 5.6 - - PHP 5.5 - - * - ext + lib 1.20 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - - - * - ext + lib 1.17 to 1.19 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - - - * - ext + lib 1.16 - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - ext + lib 1.15 [#PHP1.15-version-parity]_ - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - ext 1.14 + lib 1.13 - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - ext 1.13 + lib 1.12 - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - ext 1.12 + lib 1.11 - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - ext 1.11 + lib 1.10 - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - * - ext 1.10 + lib 1.9 - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - * - ext 1.9 + lib 1.8 - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - * - ext 1.8 + lib 1.7 - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - * - ext 1.7 + lib 1.6 - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - ext 1.6 + lib 1.5 - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - ext 1.5 + lib 1.4 - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - ext 1.4 + lib 1.3 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - ext 1.3 + lib 1.2 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ diff --git a/source/includes/language-compatibility-table-python.rst b/source/includes/language-compatibility-table-python.rst deleted file mode 100644 index 31abe64bb..000000000 --- a/source/includes/language-compatibility-table-python.rst +++ /dev/null @@ -1,532 +0,0 @@ -Python 3 Compatibility -`````````````````````` - -.. list-table:: - :header-rows: 1 - :stub-columns: 1 - :class: compatibility-large - - * - PyMongo Driver Version - - Python 3.12 - - Python 3.11 - - Python 3.10 [#ssl-4.0-issue]_ - - Python 3.9 - - Python 3.8 - - Python 3.7 - - Python 3.6 - - Python 3.5 - - Python 3.4 - - Python 3.3 - - PyPy3 - - Python 3.2 - - Python 3.1 - - * - 4.7 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - - - - - * - 4.6 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - - - - - * - 4.5 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - - - - - * - 4.4 - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - - - - - * - 4.3 - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - - - - - * - 4.2 - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - - - - - * - 4.1 - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ [#three-six-compat]_ - - - - - - - - - - - - - - * - 4.0 - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - - - * - 3.13 - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - ✓ - - - - - - * - 3.12 - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - ✓ - - - - - - * - 3.11 - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - ✓ - - - - - - * - 3.10 - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - ✓ - - - - - - * - 3.9 - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - - - ✓ - - - - - - * - 3.8 - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - - - ✓ - - - - - - * - 3.7 - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - - - ✓ - - - - - - * - 3.6 - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - - - ✓ - - - - - - * - 3.5 - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - * - 3.4 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - * - 3.3 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - * - 3.2 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - 3.1 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - 3.0 - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - 2.9 - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 2.8 - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 2.7 - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - -.. [#ssl-4.0-issue] Versions of Python 3.10 and later are not compatible with - TLS/SSL for versions of MongoDB 4.0 and earlier. See the `PyMongo documentation `__ - for more information. -.. [#three-six-compat] Pymongo 4.1 requires Python 3.6.2 or later. - -.. note:: - - PyPy3 is a Python 3.2-compatible alternative interpreter. - -Python 2 Compatibility -`````````````````````` - -.. list-table:: - :header-rows: 1 - :stub-columns: 1 - :class: compatibility-large - - * - PyMongo Driver Version - - Python 2.7, PyPy - - Python 2.6 - - Python 2.5, Jython 2.5 - - Python 2.4 - - * - 4.0 [#python-2-compat]_ - - - - - - - - - - * - 3.12 - - ✓ - - - - - - - - * - 3.11 - - ✓ - - - - - - - - * - 3.10 - - ✓ - - - - - - - - * - 3.9 - - ✓ - - - - - - - - * - 3.8 - - ✓ - - - - - - - - * - 3.7 - - ✓ - - ✓ - - - - - - - * - 3.6 - - ✓ - - ✓ - - - - - - * - 3.5 - - ✓ - - ✓ - - - - - - * - 3.4 - - ✓ - - ✓ - - - - - - * - 3.3 - - ✓ - - ✓ - - - - - - * - 3.2 - - ✓ - - ✓ - - - - - - * - 3.1 - - ✓ - - ✓ - - - - - - * - 3.0 - - ✓ - - ✓ - - - - - - * - 2.9 - - ✓ - - ✓ - - ✓ - - ✓ - - * - 2.8 - - ✓ - - ✓ - - ✓ - - ✓ - - * - 2.7 - - ✓ - - ✓ - - ✓ - - ✓ - -.. [#python-2-compat] Versions of PyMongo 4.0 and later are not compatible - with Python 2 - -.. note:: - - Jython 2.5 is a Python 2.5-compatible alternative interpreter. - - PyPy is a Python 2.7-compatible alternative interpreter. diff --git a/source/includes/mongodb-compatibility-table-cxx.rst b/source/includes/mongodb-compatibility-table-cxx.rst deleted file mode 100644 index 858f09446..000000000 --- a/source/includes/mongodb-compatibility-table-cxx.rst +++ /dev/null @@ -1,146 +0,0 @@ -.. sharedinclude:: dbx/compatibility-table-legend.rst - -.. list-table:: - :header-rows: 1 - :stub-columns: 1 - :class: compatibility-large - - * - C++ Driver Version - - MongoDB 7.0 - - MongoDB 6.0 - - MongoDB 5.0 - - MongoDB 4.4 - - MongoDB 4.2 - - MongoDB 4.0 - - MongoDB 3.6 - - MongoDB 3.4 - - MongoDB 3.2 - - MongoDB 3.0 - - MongoDB 2.6 - - MongoDB 2.4 - - * - 3.8+ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - * - 3.7 - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - * - 3.6 - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - * - 3.5 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - * - 3.4 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - * - 3.3 - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - * - 3.2 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.1 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.0 - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ diff --git a/source/includes/mongodb-compatibility-table-php.rst b/source/includes/mongodb-compatibility-table-php.rst deleted file mode 100644 index a0c39a845..000000000 --- a/source/includes/mongodb-compatibility-table-php.rst +++ /dev/null @@ -1,282 +0,0 @@ -.. Full compatibility table, for reference only. - -.. sharedinclude:: dbx/compatibility-table-legend.rst - -.. list-table:: - :header-rows: 1 - :stub-columns: 1 - :class: compatibility-large - - * - PHP Driver Versions - - MongoDB 8.0 - - MongoDB 7.0 - - MongoDB 6.0 - - MongoDB 5.0 - - MongoDB 4.4 - - MongoDB 4.2 - - MongoDB 4.0 - - MongoDB 3.6 - - MongoDB 3.4 - - MongoDB 3.2 - - MongoDB 3.0 - - MongoDB 2.6 - - * - ext + lib 1.20 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - - - * - ext + lib 1.16 to 1.19 - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - ext + lib 1.15 [#PHP1.15-version-parity]_ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - ext 1.14 + lib 1.13 - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - ext 1.13 + lib 1.12 - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - ext 1.12 + lib 1.11 - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - ext 1.11 + lib 1.10 - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - ext 1.10 + lib 1.9 - - ⊛ - - ⊛ - - ⊛ - - ✓ [#PHPC1.10-PHPLIB1.9-driver-support]_ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - ext 1.9 + lib 1.8 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - ext 1.8 + lib 1.7 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - ext 1.7 + lib 1.6 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - ext 1.6 + lib 1.5 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - ext 1.5 + lib 1.4 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - * - ext 1.4 + lib 1.3 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - ext 1.3 + lib 1.2 - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - * - ext 1.2 + lib 1.1 - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - * - ext 1.1 + lib 1.0 - - - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - * - ext 1.0 - - - - - - - - - - - - - - - - - - - - - - ✓ - - ✓ - -.. [#PHP1.15-version-parity] Version 1.14 of the MongoDB PHP library has been - skipped to restore version parity between the library and extension. - -.. [#PHPC1.10-PHPLIB1.9-driver-support] The extension 1.10 + library 1.9 - driver does not support snapshot reads on secondaries. For more - information, see the - `MongoDB Server version 5.0 release notes `__. diff --git a/source/includes/mongodb-compatibility-table-python.rst b/source/includes/mongodb-compatibility-table-python.rst deleted file mode 100644 index 97b7f5385..000000000 --- a/source/includes/mongodb-compatibility-table-python.rst +++ /dev/null @@ -1,344 +0,0 @@ -.. sharedinclude:: dbx/compatibility-table-legend.rst - -.. list-table:: - :header-rows: 1 - :stub-columns: 1 - :class: compatibility-large - - * - PyMongo Driver Version - - MongoDB 7.0 - - MongoDB 6.0 - - MongoDB 5.0 - - MongoDB 4.4 - - MongoDB 4.2 - - MongoDB 4.0 - - MongoDB 3.6 - - MongoDB 3.4 - - MongoDB 3.2 - - MongoDB 3.0 - - MongoDB 2.6 - - * - 4.7 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - 4.6 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - 4.5 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - 4.4 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - 4.3 - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - 4.2 - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - 4.1 - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - 4.0 - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - - * - 3.13 - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.12 - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.11 - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.10 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.9 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.8 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.7 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.6 - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.5 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.4 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - * - 3.3 - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - * - 3.2 - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - * - 3.1 - - - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - * - 3.0 - - - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - * - 2.9 - - - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - * - 2.8 - - - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - * - 2.7 - - - - - - - - - - - - - - - - - - - - - - ✓ diff --git a/source/includes/substitute-placeholders-aws-key.rst b/source/includes/substitute-placeholders-aws-key.rst deleted file mode 100644 index 4384383b9..000000000 --- a/source/includes/substitute-placeholders-aws-key.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. note:: Placeholder Text - - You must substitute all text in quotes and angle brackets with - your KMS configuration values. - - For example, the Node.js code prompts you to include a master key value - as follows: - - .. code-block:: javascript - :copyable: false - - masterKey: { - key: "" - ... - } - - - If your master key is "arn:aws:kms:us-east-2:111122223333:alias/test-key", - substitute the text as follows: - - .. code-block:: javascript - :copyable: false - - masterKey: { - key: "arn:aws:kms:us-east-2:111122223333:alias/test-key" - ... - } diff --git a/source/includes/substitute-placeholders-aws.rst b/source/includes/substitute-placeholders-aws.rst deleted file mode 100644 index 9a59915db..000000000 --- a/source/includes/substitute-placeholders-aws.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. note:: Placeholder Text - - You must substitute all text in quotes and angle brackets with - your KMS configuration values. - - For example, the Node.js code prompts you to include a private access key - id value as follows: - - .. code-block:: javascript - :copyable: false - - privateKey: "" - - If your AWS user access key is "23478207027842073230762374023", substitute - the text as follows: - - .. code-block:: javascript - :copyable: false - - privateKey: "23478207027842073230762374023" diff --git a/source/includes/substitute-placeholders-azure-key.rst b/source/includes/substitute-placeholders-azure-key.rst deleted file mode 100644 index 3b54f8e49..000000000 --- a/source/includes/substitute-placeholders-azure-key.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. note:: Placeholder Text - - You must substitute all text in quotes and angle brackets with - your KMS configuration values. - - For example, the Node.js code prompts you to include a key name value - as follows: - - .. code-block:: javascript - :copyable: false - - azure: { - keyName: "" - ... - } - - If your Azure master key name is "my-key-name", you should substitute the - text as follows: - - .. code-block:: javascript - :copyable: false - - azure: { - keyName: "my-key-name" - ... - } diff --git a/source/includes/substitute-placeholders-azure.rst b/source/includes/substitute-placeholders-azure.rst deleted file mode 100644 index dd2c546db..000000000 --- a/source/includes/substitute-placeholders-azure.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. note:: Placeholder Text - - You must substitute all text in quotes and angle brackets with - your KMS configuration values. - - For example, the Node.js code prompts you to include a client ID value as - follows: - - .. code-block:: javascript - :copyable: false - - azure: { - clientId: "" - ... - } - - If your Azure client ID is "12345678", you should substitute the text as - follows: - - .. code-block:: javascript - :copyable: false - - azure: { - clientId: "12345678" - ... - } diff --git a/source/includes/substitute-placeholders-gcp-key.rst b/source/includes/substitute-placeholders-gcp-key.rst deleted file mode 100644 index 78524ef4e..000000000 --- a/source/includes/substitute-placeholders-gcp-key.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. note:: Placeholder Text - - You must substitute all text in quotes and angle brackets with - your KMS configuration values. - - For example, the Node.js code prompts you to include a key ring value as - follows: - - .. code-block:: javascript - :copyable: false - - masterKey: { - keyRing: "" - ... - } - - If your GCP key ring is "my-key-ring", you should substitute the text as - follows: - - .. code-block:: javascript - :copyable: false - - masterKey: { - keyRing: "my-key-ring" - ... - } diff --git a/source/includes/substitute-placeholders-gcp.rst b/source/includes/substitute-placeholders-gcp.rst deleted file mode 100644 index a914c4c76..000000000 --- a/source/includes/substitute-placeholders-gcp.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. note:: Placeholder Text - - You must substitute all text in quotes and angle brackets with your KMS - configuration values. - - For example, the Node.js code prompts you to include a private key value - as follows: - - .. code-block:: javascript - :copyable: false - - privateKey: "" - - Suppose your GCP service account private key is the following: - - .. code-block:: none - :copyable: false - - -----BEGIN PRIVATE KEY-----\nyour-private-key\n-----END PRIVATE KEY-----\n - - Substitute the placeholder text as follows: - - .. code-block:: javascript - :copyable: false - - privateKey: "your-private-key" diff --git a/source/includes/substitute-placeholders-kmip.rst b/source/includes/substitute-placeholders-kmip.rst deleted file mode 100644 index 0a15258d7..000000000 --- a/source/includes/substitute-placeholders-kmip.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. note:: Placeholder Text - - You must substitute all text in quotes and angle brackets with - your KMIP provider configuration values. - - For example, the Java code prompts you to include a KMIP provider URI - as follows: - - .. code-block:: java - :copyable: false - - providerDetails.put("endpoint", ""); - - If your KMIP provider URI is "localhost:5696", substitute - the text as follows: - - .. code-block:: java - :copyable: false - - providerDetails.put("endpoint", "localhost:5696"); - diff --git a/tools/compact_extlinks.py b/tools/compact_extlinks.py deleted file mode 100644 index 627f6f66a..000000000 --- a/tools/compact_extlinks.py +++ /dev/null @@ -1,67 +0,0 @@ -# This script takes existing extlinks and applies them to existing docs. -# The original files are saved with the .orig suffix. -# Usage: -# python compact_extlinks.py -# E.g.: python compact_extlinks.py ../source - -import os -import sys -import re -from collections import defaultdict -from shutil import copyfile - -sys.path.append("..") -from conf import extlinks - -doc_root = sys.argv[1] - -url_valid_chars = r"[\-\._~\:/?#\[\]@!\$&\'\(\)\*\+\,;%=\w]+" -link_valid_chars = r"[\s\w!\"#$%&\'\(\)\*\+,\.\/:;=\?@\[\]\^\_\{\|\}\~\-]" - -# return: dict of extlink tag (e.g. aws-docs) => regular expression for matching rst -def extlinks_regexp(links=extlinks): - re_dict = dict() - - regexps = [] - for k, v in links.items(): - url = re.sub(r'https?://(\S+)\%s$', '\g<1>', v[0]) - - re_dict[k] = re.compile(r"(`)(" + link_valid_chars + r"*)<(\s*https?://" + url + r")(" + url_valid_chars + r")(\s*>\s*`_+)", re.MULTILINE) - - return re_dict - -link_regex = extlinks_regexp() - -urls = defaultdict(int) -num_scanned = 0 -num_created = 0 - -for dirpath, dirnames, filenames in os.walk(doc_root): - for filename in [f for f in filenames if (f.endswith(".txt") or f.endswith(".rst"))]: - updated = False - - filepath = "/".join([dirpath, filename]) - with open(filepath, 'r') as file: - num_scanned += 1 - data = file.read() - - for k, regexpr in link_regex.items(): - result = re.subn(regexpr, (":" + k + ":`\g<2><\g<4>>`"), data) - - if result[1] > 0: #num updates - updated = True - data = result[0] - - if updated: - num_created += 1 - # save the original - copyfile(filepath, (filepath + ".orig")) - - fh = open(filepath, 'w') - fh.write(data) - fh.close() - else: - continue - -print("Files scanned: %i" % num_scanned) -print("New files created: %i" % num_created)