{"id":31658404,"url":"https://github.com/couchbase/docs-quarkus-extension","last_synced_at":"2026-02-16T06:02:58.941Z","repository":{"id":273367804,"uuid":"918271956","full_name":"couchbase/docs-quarkus-extension","owner":"couchbase","description":"Couchbase Java SDK Quarkus extension docs (asciidoc)","archived":false,"fork":false,"pushed_at":"2025-12-03T14:04:35.000Z","size":48,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":10,"default_branch":"release/1.2","last_synced_at":"2025-12-06T18:28:02.910Z","etag":null,"topics":["docs","sdk"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/couchbase.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-17T15:39:46.000Z","updated_at":"2025-12-03T14:04:39.000Z","dependencies_parsed_at":"2025-05-23T10:43:41.362Z","dependency_job_id":"4f33e257-9168-4888-b380-a4d52d5373cd","html_url":"https://github.com/couchbase/docs-quarkus-extension","commit_stats":null,"previous_names":["couchbase/docs-quarkus-extension"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/couchbase/docs-quarkus-extension","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbase%2Fdocs-quarkus-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbase%2Fdocs-quarkus-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbase%2Fdocs-quarkus-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbase%2Fdocs-quarkus-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/couchbase","download_url":"https://codeload.github.com/couchbase/docs-quarkus-extension/tar.gz/refs/heads/release/1.2","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/couchbase%2Fdocs-quarkus-extension/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29501365,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T05:57:17.024Z","status":"ssl_error","status_checked_at":"2026-02-16T05:56:49.929Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","sdk"],"created_at":"2025-10-07T15:21:40.192Z","updated_at":"2026-02-16T06:02:58.936Z","avatar_url":"https://github.com/couchbase.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"= Couchbase Java SDK - Quarkus Extension Documentation\n\nThis repository hosts the documentation source for the https://docs.couchbase.com/quarkus/1.2/ROOT/overview.html[Couchbase Java SDK Quarkus Extension].\n\nThis branch documents the 1.2 release of the Extension, which follows the 3.9 release of the Java SDK,\nwhich in turn follows the https://docs.couchbase.com/java-sdk/3.9/project-docs/compatibility.html#api-version[SDK 3.8 API].\n\n\n== Contributing\n\nContributions are welcome!\nPlease test them locally, and then submit a pull request.\nA guide to using asciidoc, building Antora locally, and working with our repos can be found at https://docs.couchbase.com/home/contribute/index.html[https://docs.couchbase.com/home/contribute/index.html] (this may still be in the middle of being updated).\n\nAt a minimum, to build the docs locally, you will need this repo,\nthe https://github.com/couchbase/docs-sdk-java[Java SDK repo],\nhttps://github.com/couchbase/docs-sdk-common[docs-sdk-common],\nand the https://github.com/couchbase/docs-server[Server Docs repo]\nin your Antora playbook.\n\nIf you are not sure the best way to update the docs, please raise a GitHub issue.\n\n\n\n== Notes for Docs Maintainers\n\nThis docset sits alongside the Java SDK docs.\nThe philosophy behind the SDK docs' Information Architecture can be found in the https://docs.couchbase.com/java-sdk/3.9/project-docs/metadoc-about-these-sdk-docs.html[meta doc].\n\n=== Directory Structure\n\nAntora modules used are as follows:\n\n* devguide/examples -- the home of all code examples.\n* ROOT -- contains `nav.adoc`, the navigation file for this component, and a `pages` subdir with all of the docs content..\n\nOccasionally, a partial fragment in a `partials` directory contains content reused over more than one page.\nMost re-use is from single-sourced content in the https://github.com/couchbase/docs-sdk-common[sdk-common] repo,\nbut you will currently find little of that here.\nPartials may also be pulled in from the Java SDK.\n\n=== Single-sourced Content\n\nTo make maintenance easier for docs of around a dozen SDKs, content that is common across SDK docsets is -- wherever possible -- single-sourced from the https://github.com/couchbase/docs-sdk-common[sdk-common] repo.\nThis special repo also contains a small amount of such includes.\n\nWe recognise that this adds a slight cognitive burden for the new maintainer, but one layer of abstraction seems a reasonable compromise for maintainability.\nTo make content re-use workable, certain replaceable attributes are used.\nThese are found in the antora.yml file.\n\n.Attributes for Single-sourced Content\n|===\n| Attribute | Use\n\n| `server_version:`\n| SDK dotminor releases contain new APIs to match new Server releases.\nThis is the release version of Couchbase Server that this SDK release accompanied.\nNot often needed within the SDK documentation -- the server version in `xref` links is set with  `version-server:` (see below).\n\n| `quarkus_version:` | Sets the current patch version.\n\n| `sdk_current_version:` | Sets the current patch version of the Java SDK.\n\n| `sdk_dot_minor:` | The current Java SDK dotminor.\n\n| `sdk_dot_major:` | The current Java SDK major release -- not often needed within the documentation.\n\n| `version-server:` | This is substituted into `xref` links to the Server, to ensure they land on the correct release version.\n\n| `version-common:`\n| The version (branch) of the single-sourced `sdk-common` repo.\nThis is substituted into Antora `include::` directives, to pull in content from the correct branch.\n\n| `name_platform:` | Allows us to name the SDK within shared content (*Java*).\n\n| `name-sdk:` | Allows us to name the SDK within shared content (*Quarkus SDK extension*).\n\n| `sdk_api:` | The API version of this release.\n\n| `sdk-api-link:` | Link to the latest API Reference for the SDK.\n\n| `sdk-gh-link:` | Link to the source code of the SDK.\n\n|===\n\n\nAn additional attribute, `page-nav-header-levels: 1`, ensures that the left-hand navigation of the site opens with each topic unfurled by one level.\n\n=== Page Headers\n\nEach `.adoc` page contains information in the headers:\n\n[source,asciidoc]\n----\n= Compatibility\n:description: Platform compatibility, and features available in different SDK versions, and compatibility between Server and SDK. \\\nPlus notes on Cloud, networks, and AWS Lambda.\n:page-aliases: ROOT:overview,ROOT:compatibility-versions-features,compatibility-versions-features\n:page-toclevels: 3\n:table-caption!:\n----\n\nThe `:page-aliases:` directive enables Antora to build 502 redirects -- meaning that inbound links from, for example, old blog posts will still work with the current docset.\n\n`:page-toclevels:` should be set to `2` to include h3 headers along with h2s in the in-page navigation (right-hand nav).\nLeaving out this directive means that the page will default to `1`, showing only h2 headers in the in-page nav.\nA value of `3` should not be used, save in exceptionally complicated pages like that shown (the https://docs.couchbase.com/scala-sdk/1.6/project-docs/compatibility.html[compatibility page]).\n\n=== Patch Releases\n\nUpdate the following files:\n\n* antora.yml\n* modules/devguide/examples/java/pom.xml\n* modules/ROOT/pages/quarkus-extension-release-notes.adoc\n\n=== New Branches\n\nProduction branches use the *release/x.y* naming pattern (e.g. `release/1.7`, `release/1.6`).\nAntora uses the branch names in the playbook, but also uses the `version` given in the antor.yml file, to create the version navigation -- so this version number must be unique within the repo for any branches included in the playbook.\nWhen creating a new branch for a new release, remember to update the antora.yml file before trying to build.\n\n=== Code Sample Testing\n\nThis is in the process of being changed -- documentation will appear here once this is completed.\n\n\n== Docs License\n\n©2025 Couchbase, Inc.\nThis work is licensed under https://creativecommons.org/licenses/by-nc-sa/4.0/[CC BY-NC-SA 4.0].\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcouchbase%2Fdocs-quarkus-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcouchbase%2Fdocs-quarkus-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcouchbase%2Fdocs-quarkus-extension/lists"}