Skip to content

Commit aab6d55

Browse files
committed
Merge remote-tracking branch 'upstream/master' into DOCSP-47048-replica-set-ops
2 parents 00d5ea3 + 230c827 commit aab6d55

File tree

137 files changed

+3523
-3502
lines changed

Some content is hidden

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

137 files changed

+3523
-3502
lines changed

.github/workflows/add-netlify-links.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ name: Add Netlify Links To Changed Pages
22
on:
33
workflow_call:
44
pull_request_target:
5+
paths-ignore:
6+
- "source/**/*.ast"
57
jobs:
68
get-pr-changes:
79
name: Get Changed Files & Update PR Description
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Coverage Check for Osiris Generated AST files
2+
on:
3+
pull_request:
4+
paths:
5+
- '**/*.ast' # Only trigger if .ast files are changed
6+
branches:
7+
- main
8+
9+
jobs:
10+
check-coverage:
11+
runs-on: ubuntu-latest
12+
outputs:
13+
site_coverage_list: ${{ steps.set_coverage.outputs.site_coverage_list }}
14+
coverage_below_threshold: ${{ steps.set_coverage.outputs.coverage_below_threshold }}
15+
16+
steps:
17+
- name: Checkout Repos
18+
uses: actions/checkout@v4
19+
# uncomment when running or testing locally using [act](https://github.com/nektos/act?tab=readme-ov-file)
20+
# with:
21+
# token: ${{ secrets.API_TOKEN_GITHUB }}
22+
# ref: DOP-5399-placeholder
23+
24+
- name: Verify Branch Checkout
25+
run: |
26+
git branch --show-current # Print the current branch
27+
28+
- name: Install Wget
29+
run: sudo apt-get update && sudo apt-get install -y wget
30+
31+
- name: Clone Osiris
32+
run: git clone https://x-access-token:${{ secrets.API_TOKEN_GITHUB }}@github.com/10gen/osiris.git cloned-osiris-repo
33+
34+
- name: Run Coverage Check
35+
id: run_coverage
36+
uses: mongodb/docs-worker-actions/coverage-check@main
37+
with:
38+
repo-path: cloned-osiris-repo
39+
required-coverage: '90'
40+
41+
- name: Set Workflow Outputs
42+
id: set_coverage
43+
run: |
44+
echo "coverage_below_threshold=${coverage_below_threshold}" >> $GITHUB_OUTPUT
45+
echo "site_coverage_list=${SITE_COVERAGE_LIST}" >> $GITHUB_OUTPUT
46+
47+
send-slack-notification:
48+
runs-on: ubuntu-latest
49+
needs: check-coverage
50+
if: needs.check-coverage.outputs.coverage_below_threshold == 'true'
51+
52+
steps:
53+
- name: Send Slack Notification
54+
env:
55+
SITE_COVERAGE_LIST: ${{ needs.check-coverage.outputs.site_coverage_list }}
56+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
57+
REPOSITORY: ${{ github.repository }}
58+
PR_TITLE: ${{ github.event.pull_request.title }}
59+
PR_NUMBER: ${{ github.event.pull_request.number }}
60+
PR_URL: ${{ github.event.pull_request.html_url }}
61+
PR_SHA: ${{ github.event.pull_request.head.sha }}
62+
uses: mongodb/docs-worker-actions/coverage-report-to-slack@main
63+
with:
64+
required-coverage: '90'
65+
site-coverage-list: $SITE_COVERAGE_LIST
66+
slack-webhook-url: $SLACK_WEBHOOK_URL
67+
repository: $REPOSITORY
68+
pr-title: $PR_TITLE
69+
pr-number: $PR_NUMBER
70+
pr-url: $PR_URL
71+
pr-sha: $PR_SHA

.github/workflows/vale-tdbx.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ on:
33
pull_request:
44
paths:
55
- "source/**"
6+
paths-ignore:
7+
- "source/**/*.ast"
68

79
jobs:
810
vale:

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,7 @@ giza.log
3434
.vscode*
3535
*.swp
3636
*.code-workspace
37+
38+
# GitHub Actions
39+
.secrets
40+
event.json

config/redirects

Lines changed: 67 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,76 @@
11
define: prefix docs/drivers/java/sync
22
define: base https://www.mongodb.com/${prefix}
3-
define: versions v4.3 v4.4 v4.5 v4.6 v4.7 v4.8 v4.9 v4.10 v4.11 v5.0 v5.1 v5.2 v5.3 master
3+
define: versions v4.3 v4.4 v4.5 v4.6 v4.7 v4.8 v4.9 v4.10 v4.11 v5.0 v5.1 v5.2 v5.3 v5.4 master
44

5-
symlink: current -> v5.3
5+
symlink: current -> v5.4
66
symlink: upcoming -> master
77

88
raw: ${prefix}/ -> ${base}/current/
99
raw: ${prefix}/master -> ${base}/upcoming/
1010

1111
[*-v5.2]: ${prefix}/${version}/fundamentals/versioned-api/ -> ${base}/${version}/fundamentals/stable-api/
12-
[*-v4.6]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/fundamentals/crud/read-operations/retrieve/
13-
[*-master]: ${prefix}/${version}/fundamentals/csfle/ -> ${base}/${version}/fundamentals/encrypt-fields/
14-
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/change-a-document/ -> ${base}/${version}/fundamentals/crud/write-operations/modify/
15-
[*-v4.10]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/
16-
[*-v4.8]: ${prefix}/${version}/connection-troubleshooting/ -> ${base}/${version}/
17-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/ -> ${base}/${version}/crud/
18-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/crud/read-operations/
19-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/read-operations/retrieve/
20-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/cursor/ -> ${base}/${version}/crud/read-operations/cursor/
21-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/logging-monitoring/change-streams/
22-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/sort/ -> ${base}/${version}/crud/read-operations/sort/
23-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/skip/ -> ${base}/${version}/crud/read-operations/skip/
24-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/limit/ -> ${base}/${version}/crud/read-operations/limit/
25-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/project/ -> ${base}/${version}/crud/read-operations/project/
26-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/geo/ -> ${base}/${version}/crud/read-operations/geo/
27-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/text/ -> ${base}/${version}/crud/read-operations/text/
28-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/ -> ${base}/${version}/crud/write-operations/
29-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/insert/ -> ${base}/${version}/crud/write-operations/insert/
30-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/delete/ -> ${base}/${version}/crud/write-operations/delete/
31-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/modify/ -> ${base}/${version}/crud/write-operations/modify/
32-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/embedded-arrays/ -> ${base}/${version}/crud/write-operations/embedded-arrays/
33-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/upsert/ -> ${base}/${version}/crud/write-operations/upsert/
34-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk/ -> ${base}/${version}/crud/write-operations/bulk/
35-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/query-document/ -> ${base}/${version}/crud/query-document/
36-
[v5.3-master]: ${prefix}/${version}/fundamentals/crud/compound-operations/ -> ${base}/${version}/crud/compound-operations/
37-
[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/ -> ${base}/${version}/data-formats/
38-
[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-bson/ -> ${base}/${version}/data-formats/document-data-format-bson/
39-
[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-extended-json/ -> ${base}/${version}/data-formats/document-data-format-extended-json/
40-
[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/documents/ -> ${base}/${version}/data-formats/documents/
41-
[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-pojo/ -> ${base}/${version}/data-formats/document-data-format-pojo/
42-
[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-record/ -> ${base}/${version}/data-formats/document-data-format-record/
43-
[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/pojo-customization/ -> ${base}/${version}/data-formats/pojo-customization/
44-
[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/codecs/ -> ${base}/${version}/data-formats/codecs/
45-
[v5.3-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connection/
46-
[v5.3-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/connect/
47-
[v5.3-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connection/connection-options/
48-
[v5.3-master]: ${prefix}/${version}/fundamentals/connection/mongoclientsettings/ -> ${base}/${version}/connection/mongoclientsettings/
49-
[v5.3-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connection/network-compression/
50-
[v5.3-master]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/connection/socks/
51-
[v5.3-master]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/${version}/security/tls/
52-
[v5.3-master]: ${prefix}/${version}/fundamentals/connection/jndi/ -> ${base}/${version}/connection/jndi/
53-
[v5.3-master]: ${prefix}/${version}/fundamentals/builders/ -> ${base}/${version}/crud/builders/
54-
[v5.3-master]: ${prefix}/${version}/fundamentals/builders/aggregates/ -> ${base}/${version}/crud/builders/aggregates/
55-
[v5.3-master]: ${prefix}/${version}/fundamentals/builders/filters/ -> ${base}/${version}/crud/builders/filters/
56-
[v5.3-master]: ${prefix}/${version}/fundamentals/builders/indexes/ -> ${base}/${version}/crud/builders/indexes/
57-
[v5.3-master]: ${prefix}/${version}/fundamentals/builders/projections/ -> ${base}/${version}/crud/builders/projections/
58-
[v5.3-master]: ${prefix}/${version}/fundamentals/builders/sort/ -> ${base}/${version}/crud/builders/sort/
59-
[v5.3-master]: ${prefix}/${version}/fundamentals/builders/updates/ -> ${base}/${version}/crud/builders/updates/
60-
[v5.3-master]: ${prefix}/${version}/fundamentals/builders/vector-search -> ${base}/${version}/atlas-vector-search/
61-
[v5.3-master]: ${prefix}/${version}/fundamentals/aggregation/ -> ${base}/${version}/crud/aggregation/
62-
[v5.3-master]: ${prefix}/${version}/fundamentals/aggregation-expression-operations/ -> ${base}/${version}/crud/aggregation-expression-operations/
63-
[v5.3-master]: ${prefix}/${version}/fundamentals/collations/ -> ${base}/${version}/crud/collations/
64-
[v5.3-master]: ${prefix}/${version}/fundamentals/stable-api/ -> ${base}/${version}/connection/stable-api/
65-
[v5.3-master]: ${prefix}/${version}/connection-troubleshooting/ -> ${base}/${version}/connection/connection-troubleshooting/
66-
[v5.3-master]: ${prefix}/${version}/fundamentals/gridfs/ -> ${base}/${version}/crud/gridfs/
67-
[v5.3-master]: ${prefix}/${version}/fundamentals/transactions/ -> ${base}/${version}/crud/transactions/
68-
[v5.3-master]: ${prefix}/${version}/fundamentals/time-series/ -> ${base}/${version}/data-formats/time-series/
69-
[v5.3-master]: ${prefix}/${version}/quick-start/ -> ${base}/${version}/getting-started/
70-
[v5.3-master]: ${prefix}/${version}/fundamentals/databases-collections/ -> ${base}/${version}/getting-started/databases-collections/
71-
[v5.3-master]: ${prefix}/${version}/integrations/ -> ${base}/${version}/getting-started/integrations/
72-
[v5.3-master]: ${prefix}/${version}/quick-reference/ -> ${base}/${version}/getting-started/quick-reference/
73-
[v5.3-master]: ${prefix}/${version}/fundamentals/enterprise-auth/ -> ${base}/${version}/security/enterprise-auth/
74-
[v5.3-master]: ${prefix}/${version}/connection/socks/ -> ${base}/${version}/security/socks/
12+
13+
# TOC evolution redirects
14+
15+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/ -> ${base}/${version}/crud/
16+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/crud/query-documents/
17+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/query-documents/find/
18+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/read-operations/cursor/ -> ${base}/${version}/crud/query-documents/cursor/
19+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/logging-monitoring/change-streams/
20+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/read-operations/sort/ -> ${base}/${version}/crud/query-documents/sort/
21+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/read-operations/skip/ -> ${base}/${version}/crud/query-documents/skip/
22+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/read-operations/limit/ -> ${base}/${version}/crud/query-documents/limit/
23+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/read-operations/project/ -> ${base}/${version}/crud/query-documents/project/
24+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/read-operations/geo/ -> ${base}/${version}/crud/query-documents/geo/
25+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/read-operations/text/ -> ${base}/${version}/crud/query-documents/text/
26+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/write-operations/ -> ${base}/${version}/crud/insert/
27+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/write-operations/insert/ -> ${base}/${version}/crud/insert/
28+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/write-operations/delete/ -> ${base}/${version}/crud/update-documents/delete/
29+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/write-operations/modify/ -> ${base}/${version}/crud/update-documents/
30+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/write-operations/embedded-arrays/ -> ${base}/${version}/crud/update-documents/embedded-arrays/
31+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/write-operations/upsert/ -> ${base}/${version}/crud/update-documents/upsert/
32+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk/ -> ${base}/${version}/crud/bulk/
33+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/query-document/ -> ${base}/${version}/crud/query-documents/specify-query/
34+
[v5.0-*]: ${prefix}/${version}/fundamentals/crud/compound-operations/ -> ${base}/${version}/crud/compound-operations/
35+
36+
[v5.0-*]: ${prefix}/${version}/fundamentals/data-formats/ -> ${base}/${version}/data-formats/
37+
[v5.0-*]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-bson/ -> ${base}/${version}/data-formats/document-data-format-bson/
38+
[v5.0-*]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-extended-json/ -> ${base}/${version}/data-formats/document-data-format-extended-json/
39+
[v5.0-*]: ${prefix}/${version}/fundamentals/data-formats/documents/ -> ${base}/${version}/data-formats/documents/
40+
[v5.0-*]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-pojo/ -> ${base}/${version}/data-formats/document-data-format-pojo/
41+
[v5.0-*]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-record/ -> ${base}/${version}/data-formats/document-data-format-record/
42+
[v5.0-*]: ${prefix}/${version}/fundamentals/data-formats/pojo-customization/ -> ${base}/${version}/data-formats/pojo-customization/
43+
[v5.0-*]: ${prefix}/${version}/fundamentals/data-formats/codecs/ -> ${base}/${version}/data-formats/codecs/
44+
45+
[v5.0-*]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connection/
46+
[v5.0-*]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/mongoclient
47+
[v5.0-*]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connection/connection-options/
48+
[v5.0-*]: ${prefix}/${version}/fundamentals/connection/mongoclientsettings/ -> ${base}/${version}/connection/mongoclientsettings/
49+
[v5.0-*]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connection/network-compression/
50+
[v5.0-*]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/connection/socks/
51+
[v5.0-*]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/${version}/security/tls/
52+
[v5.0-*]: ${prefix}/${version}/fundamentals/connection/jndi/ -> ${base}/${version}/connection/jndi/
53+
54+
[v5.0-*]: ${prefix}/${version}/fundamentals/builders/ -> ${base}/${version}/builders/
55+
[v5.0-*]: ${prefix}/${version}/fundamentals/builders/aggregates/ -> ${base}/${version}/builders/aggregates/
56+
[v5.0-*]: ${prefix}/${version}/fundamentals/builders/filters/ -> ${base}/${version}/builders/filters/
57+
[v5.0-*]: ${prefix}/${version}/fundamentals/builders/indexes/ -> ${base}/${version}/builders/indexes/
58+
[v5.0-*]: ${prefix}/${version}/fundamentals/builders/projections/ -> ${base}/${version}/builders/projections/
59+
[v5.0-*]: ${prefix}/${version}/fundamentals/builders/sort/ -> ${base}/${version}/builders/sort/
60+
[v5.0-*]: ${prefix}/${version}/fundamentals/builders/updates/ -> ${base}/${version}/builders/updates/
61+
[v5.0-*]: ${prefix}/${version}/fundamentals/builders/vector-search -> ${base}/${version}/atlas-vector-search/
62+
63+
[v5.0-*]: ${prefix}/${version}/fundamentals/aggregation/ -> ${base}/${version}/aggregation/
64+
[v5.0-*]: ${prefix}/${version}/fundamentals/aggregation-expression-operations/ -> ${base}/${version}/aggregation/aggregation-expression-operations/
65+
[v5.0-*]: ${prefix}/${version}/fundamentals/collations/ -> ${base}/${version}/crud/collations/
66+
[v5.0-*]: ${prefix}/${version}/fundamentals/stable-api/ -> ${base}/${version}/connection/stable-api/
67+
[v5.0-*]: ${prefix}/${version}/connection-troubleshooting/ -> ${base}/${version}/connection/connection-troubleshooting/
68+
[v5.0-*]: ${prefix}/${version}/fundamentals/gridfs/ -> ${base}/${version}/crud/gridfs/
69+
[v5.0-*]: ${prefix}/${version}/fundamentals/transactions/ -> ${base}/${version}/crud/transactions/
70+
[v5.0-*]: ${prefix}/${version}/fundamentals/time-series/ -> ${base}/${version}/data-formats/time-series/
71+
[v5.0-*]: ${prefix}/${version}/quick-start/ -> ${base}/${version}/getting-started/
72+
[v5.0-*]: ${prefix}/${version}/fundamentals/databases-collections/ -> ${base}/${version}/getting-started/databases-collections/
73+
[v5.0-*]: ${prefix}/${version}/integrations/ -> ${base}/${version}/getting-started/integrations/
74+
[v5.0-*]: ${prefix}/${version}/quick-reference/ -> ${base}/${version}/getting-started/quick-reference/
75+
[v5.0-*]: ${prefix}/${version}/fundamentals/enterprise-auth/ -> ${base}/${version}/security/enterprise-auth/
76+
[v5.0-*]: ${prefix}/${version}/connection/socks/ -> ${base}/${version}/security/socks/

snooty.toml

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,17 @@ intersphinx = [
77
]
88

99
toc_landing_pages = [
10-
"/get-started",
1110
"/connection",
12-
"/crud",
13-
"/crud/builders",
11+
"/connection/specify-connection-options",
12+
"/crud/update-documents",
13+
"/aggregation",
14+
"/builders",
1415
"/data-formats",
16+
"/references",
17+
"/logging-monitoring",
1518
"/api-documentation",
16-
"/security/auth"
19+
"/security",
20+
"/security/auth",
1721
]
1822

1923
sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
@@ -22,11 +26,12 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/"
2226
driver = "java"
2327
driver-long = "MongoDB Java Driver"
2428
driver-short = "Java driver"
25-
version = "5.3"
29+
version = "5.4"
2630
full-version = "{+version+}.0"
2731
mdb-server = "MongoDB Server"
2832
package-name-org = "mongodb-org"
2933
api = "https://mongodb.github.io/mongo-java-driver/{+version+}"
34+
core-api = "https://mongodb.github.io/mongo-java-driver/{+version+}/apidocs/mongodb-driver-core"
3035
stable-api = "Stable API"
3136
mongocrypt-version = "{+full-version+}"
3237
nettyVersion = "io.netty:netty-all:4.1.87.Final"

0 commit comments

Comments
 (0)