ref index

Author: RichardSmedley

modules/ref/pages/index.adoc

@@ -0,0 +1,85 @@
+= Reference Pages
+:page-toclevels: 2
+:page-aliases: concept-docs:concepts.adoc
+:description: Essential reference infomation for developing with Couchbase.
+
+
+// Note to editors
+// 
+// This page pulls in content from -sdk-common-
+// and code samples from -example-dir-
+// 
+// It can be seen built at https://docs.couchbase.com/scala-sdk/1.6/ref/index.html
+
+[abstract]
+{description}
+
+
+This section contains the following reference docs:
+
+* {sdk-api-link}[API Reference^]
+* xref:ref:client-settings.adoc[]
+* xref:ref:error-codes.adoc[Error Code Reference]
+* xref:ref:glossary.adoc[Glossary]
+* xref:ref:travel-app-data-model.adoc[]
+
+
+== A Deeper Dive
+
+The Couchbase SDK docs aim to be practical, and example-led, to get you working with any of our features as quickly as possible.
+At some point during your journey through these Howto docs, you may feel the need for a deeper dive into certain topics.
+Concept docs offer discussion-style expansions of key Couchbase features, which go beyond the dry, bare-bones reference of the API docs, and aim to give a clear understanding of the chosen topic.
+
+These are interspersed with the howto guides -- 
+but the complete set of discussion docs for the SDK is listed and linked below:
+
+
+// TODO - put this in a better order.
+
+* xref:concept-docs:buckets-and-clusters.adoc[Buckets & Clusters]
+* xref:concept-docs:collections.adoc[Collections & Scope]
+* xref:concept-docs:compression.adoc[Compression]
+* xref:concept-docs:data-model.adoc[Data Model]
+** xref:concept-docs:documents.adoc[Documents]
+** xref:concept-docs:nonjson.adoc[Non-json Docs]
+** xref:concept-docs:subdocument-operations.adoc[Sub-Documents]
+** xref:concept-docs:xattr.adoc[XATTR & Virtual XATTR]
+* xref:concept-docs:errors.adoc[Errors and Diagnostics]
+** xref:concept-docs:health-check.adoc[Health Check]
+** xref:concept-docs:response-time-observability.adoc[Tracing]
+* xref:concept-docs:durability-replication-failure-considerations.adoc[Failure Considerations]
+* xref:concept-docs:encryption.adoc[Field Level Encryption]
+* xref:concept-docs:data-services.adoc[Service Selection / Querying your Data]
+** xref:concept-docs:analytics-for-sdk-users.adoc[Analytics]
+** xref:concept-docs:understanding-views.adoc[Map Reduce Views]
+** xref:concept-docs:n1ql-query.adoc[Query]
+** xref:concept-docs:full-text-search-overview.adoc[Search]
+* xref:concept-docs:sdk-user-management-overview.adoc[User Management]
+** xref:concept-docs:certificate-based-authentication.adoc[Cert Auth]
+** xref:concept-docs:rbac.adoc[RBAC]
+
+// +
+
+* xref:concept-docs:data-durability-acid-transactions.adoc[Data Modelling, Durability, and Consistency]
+
+* xref:concept-docs:querying-your-data.adoc[]
+
+* xref:concept-docs:durability-replication-failure-considerations.adoc[]
+
+* xref:concept-docs:best-practices.adoc[]
+
+* xref:concept-docs:management-api.adoc[Managing Couchbase]
+
+
+* xref:project-docs:deployment.adoc[SDK Deployment]
+
+
+
+
+
+////
+External links.
+
+Discussion / Concept /  Understanding
+docs.
+////