DOC-11409_edit_parameter_reference_in_release_7.2

README.md

@@ -1,2 +1,117 @@
-# docs-devex
-Devex documentation shared across Server, Capella, and Elixir
+# Couchbase Developer Documentation
+
+This repository contains the developer documentation shared across Couchbase Server and Couchbase Capella.
+
+The developer documentation includes introductions, tutorials, developer guides, and reference guides for specific Couchbase services.
+
+This repository is the implementation of the striping strategy that the Documentation team discussed at the 2023 Docs Summit.
+
+## How Does This Work?
+
+The goal of this repository is to create a consistent experience for shared content across Server and Capella.
+
+This repository contains branches for the different products and versions you would need to support with devex docs.
+
+By using an included partial `nav.adoc` file, you can seamlessly include documentation from this repository into the Server and Capella documentation.
+
+The workflow for developing documentation in this repository should look similar to the following:
+
+1. Choose your base product for developing the documentation. For example, you could decide to start writing your docs in a new feature branch based on the `release/7.2` branch for Server, or directly on that branch in a new folder under `modules`.
+
+2. Write your documentation files as normal.
+
+3. Create a ToC in the `partials` folder for those documentation files:
+
+```
+* xref:my-new-module:intro.adoc[]
+** xref:my-new-module:new-content.adoc[]
+```
+
+4. Copy your new documentation files into the `capella` branch, or a new Capella feature branch based on your Server feature branch.
+
+5. Make the necessary tweaks for the documentation to apply to Capella.
+
+6. If you created feature branches for your work, merge them into the `release/7.2` or `capella` branches in this repository.
+
+7. Go to the `docs-server` and `couchbase-cloud` repositories, as described in [Configure Your Local nav.adoc Files](#configure-your-local-navadoc-files), and add your partials to those nav.adoc files.
+
+Ta-da, you've created devex documentation!
+
+## How to Build Docs With This Repository
+
+To add the content from the docs-devex repository to your local Antora builds:
+
+1. [Configure Your local-antora-playbook.yml](#configure-your-local-antora-playbookyml).
+
+2. [Configure Your Local nav.adoc Files](#configure-your-local-navadoc-files).
+
+3. In a terminal, run `antora local-antora-playbook.yml`.
+
+> **NOTE**: If you run into unexpected behavior when attempting to build (like files not appearing as expected, other errors), add the `--fetch` flag to the end of the `antora local-antora-playbook.yml` command.
+
+### Configure Your local-antora-playbook.yml
+
+You need to start by including this repository in your `local-antora-playbook.yml` file:
+
+1. In the `docs-site` repository, open your `local-antora-playbook.yml` file in a text editor.
+
+2. Under the `sources` key, add a new `url` entry for https://github.com/couchbaselabs/docs-devex.
+
+3. In the `branches` key for the new `url`, add the branches that you want to include in your build. For example, `[capella,release/7.2]` for the Couchbase Capella and Couchbase Server 7.2 branches.
+
+4. Make sure that your `sources` key includes `url` keys for your local copies of the `couchbase-cloud` and `docs-server` repositories.
+
+> **NOTE**: If you want to create a build using a local copy of two different branches from the `docs-devex` repository, see [Use Worktrees to Create a Fully Local Build](#use-worktrees-to-create-a-fully-local-build).
+
+### Configure Your Local nav.adoc Files
+
+Then, make sure that you include the nav partial files into the navigation for Server and Capella:
+
+1. In your local copy of the `docs-server` repository, go to **modules** > **ROOT**.
+
+2. Open the `nav.adoc` file in a text editor.
+
+3. In the ToC structure, choose where you want to include the navigation for the devex branch.
+
+4. Add an include for the `nav.adoc` partial from the devex branch:
+
+```
+include::<MODULE_NAME>:partial$nav.adoc[]
+```
+
+5. Repeat Steps 2-4 for the `couchbase-cloud` repository's `nav.adoc` file, located in **docs** > **public** > **modules** > **ROOT**.
+
+
+### Use Worktrees to Create a Fully Local Build
+
+If you're creating new branches in the docs-devex repository and want to create a fully local build, you'll need to use git worktrees:
+
+1. Open your `docs-devex` repository in a terminal window.
+
+2. In the terminal, enter `git worktree add <LOCAL_FOLDER_NAME> <BRANCH_NAME>`. It's recommended to give your local folder the same name as the branch.
+
+3. Repeat Step 2 for all of the branches you need on your local machine.
+
+4. In the `docs-site` repository, open your `local-antora-playbook.yml` file in a text editor.
+
+5. Change the `url` key for the `docs-devex` branch to point to your local copy of the repository.
+
+6. Set the `branches` key for the `docs-devex` branch to include the branches you added as worktrees.
+
+7. Under the `branches` key, add a `worktrees` key set to `true`:
+
+```
+- url: ../docs-devex
+  branches: [my-server-branch, my-capella-branch]
+  worktrees: true
+```
+
+You should be able to build your documentation using the local copies of your branches.
+
+When you want to make changes, edit the files in the specific worktree folder for your branch.
+
+## License
+
+The Couchbase Developer Documentation © 2024 by Couchbase Inc. is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International.
+
+See the LICENSE file or the [Creative Commons CC BY-NC-SA 4.0 license page](https://creativecommons.org/licenses/by-nc-sa/4.0/) for details.

antora.yml

@@ -1,2 +1,6 @@
-name: server
-version: '7.2'
+name: cloud
+version: ~
+asciidoc:
+  attributes:
+    ui-name: Capella UI
+    product-name: Capella

diagrams.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+[[ -d ./build ]] || mkdir ./build
+
+# install-rr
+[[ -f ./build/rr-2.0-java11.zip ]] || curl -L -o ./build/rr-2.0-java11.zip https://github.com/GuntherRademacher/rr/releases/download/v2.0/rr-2.0-java11.zip
+
+# extract-rr
+[[ -f ./build/rr/rr.war ]] || unzip ./build/rr-2.0-java11.zip -d ./build/rr
+
+for file in n1ql dcl ddl dml dql tcl hints utility
+do
+
+  # generate-rr
+  java -jar ./build/rr/rr.war -png -noembedded -out:./build/railroads.zip -width:776 -keeprecursion -nofactoring -noinline ./modules/n1ql/partials/grammar/${file}.ebnf
+
+  # extract-diagrams
+  unzip -o ./build/railroads.zip -d ./build/tmp
+  mv -f ./build/tmp/diagram/*.png ./modules/n1ql/assets/images/n1ql-language-reference
+
+done

modules/ROOT/partials/component-signpost.adoc

@@ -0,0 +1,17 @@
+// `flag-devex-escape-hatch` is a flag to hide the feature from production until ready.
+// Use `no-escape-hatch` to turn off the escape hatch for individual pages.
+// Use `escape-hatch` to override the escape hatch xref for individual pages.
+ifdef::flag-devex-escape-hatch[]
+[.signpost]
+icon:cloud[fw]
+This page is for Couchbase Capella.
+ifndef::no-escape-hatch[]
+For Couchbase Server, see
+ifdef::escape-hatch[]
+xref:{escape-hatch}[].
+endif::escape-hatch[]
+ifndef::escape-hatch[]
+xref:server:{page-module}:{docname}.adoc[].
+endif::escape-hatch[]
+endif::no-escape-hatch[]
+endif::flag-devex-escape-hatch[]

modules/ROOT/partials/query-context.adoc

@@ -0,0 +1,24 @@
+// tag::statement[]
+To use the examples on this page, you must set the query context to the `inventory` scope in the travel sample dataset.
+For more information, see xref:n1ql:n1ql-intro/queriesandresults.adoc#query-context[Query Context].
+// end::statement[]
+
+// tag::step[]
+Set the query context to the `inventory` scope in the travel sample dataset.
+For more information, see xref:n1ql:n1ql-intro/queriesandresults.adoc#query-context[Query Context].
+// end::step[]
+
+// tag::section[]
+To try the examples in this section, set the query context to the `inventory` scope in the travel sample dataset.
+For more information, see xref:n1ql:n1ql-intro/queriesandresults.adoc#query-context[Query Context].
+// end::section[]
+
+// tag::example[]
+For this example, set the query context to the `inventory` scope in the travel sample dataset.
+For more information, see xref:n1ql:n1ql-intro/queriesandresults.adoc#query-context[Query Context].
+// end::example[]
+
+// tag::unset[]
+For this example, unset the query context.
+For more information, see xref:n1ql:n1ql-intro/queriesandresults.adoc#query-context[Query Context].
+// end::unset[]

modules/develop/pages/intro.adoc

@@ -0,0 +1,102 @@
+= Developer Intro
+:page-role: tiles -toc
+:description: This section contains tutorials, how-to guides, and information about Couchbase Services to help you develop applications.
+:!sectids:
+:page-aliases: concepts:application-development,guides:intro.adoc
+
+// Pass through HTML styles for this page.
+
+ifdef::basebackend-html[]
+++++
+<style type="text/css">
+  /* Extend heading across page width */
+  div.page-heading-title,
+  div.contributor-list-box,
+  div#preamble,
+  nav.pagination {
+    flex-basis: 100%;
+  }
+</style>
+++++
+endif::[]
+
+{description}
+It also provides links to the documentation for software development kits and other integrations.
+
+include::ROOT:partial$component-signpost.adoc[]
+
+== Developer Tutorial
+
+This tutorial provides an introductory worked example for developers, showing how to use a software development kit with a simple database.
+
+* xref:tutorials:couchbase-tutorial-student-records.adoc[]
+
+== Connect
+
+Choose how you want to connect your app to Couchbase Capella.
+
+* xref:cloud:get-started:connect.adoc[]
+
+== Data
+
+Use the Data Service for key-value (CRUD) operations and to import or export data.
+
+* xref:guides:data.adoc[]
+
+== Query
+
+Use the Query Service and the Index Service to issue {sqlpp} queries to extract and manipulate data.
+
+* xref:n1ql:query.adoc[]
+
+== Vector Search
+
+Vector Search builds on the Search Service to provide support for vector indexes.
+You can use vector indexes with existing Large Language Models to develop AI applications.
+
+* xref:vector-search:vector-search.adoc[]
+
+== Search
+
+Use the Search Service for full-text search with natural language processing across multiple data types and languages.
+Use custom text analysis, Geospatial search, and more.
+
+* xref:search:search.adoc[]
+
+== Eventing
+
+Use the Eventing Service to respond to changes to your data in near real-time.
+Execute custom code in response to mutations, or as scheduled by timers.
+
+* xref:eventing:eventing-overview.adoc[]
+
+== Analytics
+
+Use the Analytics Service for online analytical processing (OLAP) for large datasets, with complex analytical or ad hoc queries.
+
+* xref:clusters:analytics-service/analytics-service.adoc[]
+
+== Mobile
+
+Use App Services in combination with Couchbase Mobile to develop mobile apps.
+
+* xref:mobile-guides:intro.adoc[]
+
+== SDKs
+
+Couchbase offers numerous software development kits (SDKs) that provide programmatic access to Couchbase Capella.
+
+* xref:home:ROOT:sdk.adoc[]
+
+== Integrations
+
+Integrations that Couchbase or partners have developed to enhance Couchbase, Capella, and partner services --
+a vital tool for many larger development projects.
+
+* xref:third-party:integrations.adoc[]
+
+== Migration
+
+A tutorial exercise demonstrating how to migrate your data from a MySQL server over to Couchbase Capella.
+
+* xref:tutorials:migration-tutorial-capella/sql-migration-tutorial-capella.adoc[]

modules/develop/partials/nav.adoc

@@ -0,0 +1 @@
+* xref:develop:intro.adoc[]