3.0.7 doc creation and update (#122) (#124)

Authored-by: James M <35449344+JMercerGit@users.noreply.github.com>
TI-Tokyo · Aug 5, 2022 · 9f85fa4 · 9f85fa4
1 parent 3143627
commit 9f85fa4
Show file tree

Hide file tree

Showing 298 changed files with 67,237 additions and 2 deletions.
diff --git a/config.yaml b/config.yaml
@@ -102,8 +102,8 @@ params:
         - ["2.1.1", "2.1.3", "2.1.4"]
         - ["2.2.0", "2.2.1", "2.2.2", "2.2.3", "2.2.6"]
         - ["2.9.0p5", "2.9.1", "2.9.2", "2.9.4", "2.9.7", "2.9.8", "2.9.9", "2.9.10"]
-        - ["3.0.1", "3.0.2", "3.0.3", "3.0.4", "3.0.6"]
-      latest: "3.0.6"
+        - ["3.0.1", "3.0.2", "3.0.3", "3.0.4", "3.0.6", "3.0.7"]
+      latest: "3.0.7"
       lts: ["2.9", "3.0"]
       archive_below: "2.2"
       #archived_url: "http://docs.riak.com/riak/1.4.12/"

diff --git a/content/riak/kv/3.0.7/_reference-links.md b/content/riak/kv/3.0.7/_reference-links.md
@@ -0,0 +1,254 @@
+
+# Riak KV 3.0.7 Reference Links List
+
+
+## Common
+
+[downloads]: {{<baseurl>}}riak/kv/3.0.7/downloads/
+[install index]: {{<baseurl>}}riak/kv/3.0.7/setup/installing
+[upgrade index]: {{<baseurl>}}riak/kv/3.0.7/upgrading
+[plan index]: {{<baseurl>}}riak/kv/3.0.7/planning
+[config index]: {{<baseurl>}}riak/kv/3.0.7/using/configuring/
+[config reference]: {{<baseurl>}}riak/kv/3.0.7/configuring/reference/
+[manage index]: {{<baseurl>}}riak/kv/3.0.7/using/managing
+[performance index]: {{<baseurl>}}riak/kv/3.0.7/using/performance
+[glossary vnode]: {{<baseurl>}}riak/kv/3.0.7/learn/glossary/#vnode
+[contact basho]: https://www.tiot.jp/en/about-us/contact-us/
+
+
+## Planning
+
+[plan index]: {{<baseurl>}}riak/kv/3.0.7/setup/planning
+[plan start]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/start
+[plan backend]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/backend
+[plan backend bitcask]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/backend/bitcask
+[plan backend leveldb]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/backend/leveldb
+[plan backend leveled]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/backend/leveled
+[plan backend memory]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/backend/memory
+[plan backend multi]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/backend/multi
+[plan cluster capacity]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/cluster-capacity
+[plan bitcask capacity]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/bitcask-capacity-calc
+[plan best practices]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/best-practices
+[plan future]: {{<baseurl>}}riak/kv/3.0.7/setup/planning/future
+
+
+## Installing
+
+[install index]: {{<baseurl>}}riak/kv/3.0.7/setup/installing
+[install aws]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/amazon-web-services
+[install debian & ubuntu]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/debian-ubuntu
+[install freebsd]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/freebsd
+[install mac osx]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/mac-osx
+[install rhel & centos]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/rhel-centos
+[install smartos]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/smartos
+[install solaris]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/solaris
+[install suse]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/suse
+[install windows azure]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/windows-azure
+
+[install source index]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/source
+[install source erlang]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/source/erlang
+[install source jvm]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/source/jvm
+
+[install verify]: {{<baseurl>}}riak/kv/3.0.7/setup/installing/verify
+
+
+## Upgrading
+
+[upgrade index]: {{<baseurl>}}riak/kv/3.0.7/setup/upgrading
+[upgrade checklist]: {{<baseurl>}}riak/kv/3.0.7/setup/upgrading/checklist
+[upgrade version]: {{<baseurl>}}riak/kv/3.0.7/setup/upgrading/version
+[upgrade cluster]: {{<baseurl>}}riak/kv/3.0.7/setup/upgrading/cluster
+[upgrade mdc]: {{<baseurl>}}riak/kv/3.0.7/setup/upgrading/multi-datacenter
+[upgrade downgrade]: {{<baseurl>}}riak/kv/3.0.7/setup/downgrade
+
+
+## Configuring
+
+[config index]: {{<baseurl>}}riak/kv/3.0.7/configuring
+[config basic]: {{<baseurl>}}riak/kv/3.0.7/configuring/basic
+[config backend]: {{<baseurl>}}riak/kv/3.0.7/configuring/backend
+[config manage]: {{<baseurl>}}riak/kv/3.0.7/configuring/managing
+[config reference]: {{<baseurl>}}riak/kv/3.0.7/configuring/reference/
+[config strong consistency]: {{<baseurl>}}riak/kv/3.0.7/configuring/strong-consistency
+[config load balance]: {{<baseurl>}}riak/kv/3.0.7/configuring/load-balancing-proxy
+[config mapreduce]: {{<baseurl>}}riak/kv/3.0.7/configuring/mapreduce
+[config search]: {{<baseurl>}}riak/kv/3.0.7/configuring/search/
+
+[config v3 mdc]: {{<baseurl>}}riak/kv/3.0.7/configuring/v3-multi-datacenter
+[config v3 nat]: {{<baseurl>}}riak/kv/3.0.7/configuring/v3-multi-datacenter/nat
+[config v3 quickstart]: {{<baseurl>}}riak/kv/3.0.7/configuring/v3-multi-datacenter/quick-start
+[config v3 ssl]: {{<baseurl>}}riak/kv/3.0.7/configuring/v3-multi-datacenter/ssl
+
+[config v2 mdc]: {{<baseurl>}}riak/kv/3.0.7/configuring/v2-multi-datacenter
+[config v2 nat]: {{<baseurl>}}riak/kv/3.0.7/configuring/v2-multi-datacenter/nat
+[config v2 quickstart]: {{<baseurl>}}riak/kv/3.0.7/configuring/v2-multi-datacenter/quick-start
+[config v2 ssl]: {{<baseurl>}}riak/kv/3.0.7/configuring/v2-multi-datacenter/ssl
+
+
+
+## Using
+
+[use index]: {{<baseurl>}}riak/kv/3.0.7/using/
+[use admin commands]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-admin-commands
+[use running cluster]: {{<baseurl>}}riak/kv/3.0.7/using/running-a-cluster
+
+### Reference
+
+[use ref custom code]: {{<baseurl>}}riak/kv/3.0.7/using/reference/custom-code
+[use ref handoff]: {{<baseurl>}}riak/kv/3.0.7/using/reference/handoff
+[use ref monitoring]: {{<baseurl>}}riak/kv/3.0.7/using/reference/statistics-monitoring
+[use ref search]: {{<baseurl>}}riak/kv/3.0.7/using/reference/search
+[use ref 2i]: {{<baseurl>}}riak/kv/3.0.7/using/reference/secondary-indexes
+[use ref snmp]: {{<baseurl>}}riak/kv/3.0.7/using/reference/snmp
+[use ref strong consistency]: {{<baseurl>}}riak/kv/3.0.7/using/reference/strong-consistency
+[use ref jmx]: {{<baseurl>}}riak/kv/3.0.7/using/reference/jmx
+[use ref obj del]: {{<baseurl>}}riak/kv/3.0.7/using/reference/object-deletion/
+[use ref v3 mdc]: {{<baseurl>}}riak/kv/3.0.7/using/reference/v3-multi-datacenter
+[use ref v2 mdc]: {{<baseurl>}}riak/kv/3.0.7/using/reference/v2-multi-datacenter
+
+### Cluster Admin
+
+[use admin index]: {{<baseurl>}}riak/kv/3.0.7/using/admin/
+[use admin commands]: {{<baseurl>}}riak/kv/3.0.7/using/admin/commands/
+[use admin riak cli]: {{<baseurl>}}riak/kv/3.0.7/using/admin/riak-cli/
+[use admin riak-admin]: {{<baseurl>}}riak/kv/3.0.7/using/admin/riak-admin/
+[use admin riak control]: {{<baseurl>}}riak/kv/3.0.7/using/admin/riak-control/
+
+### Cluster Operations
+
+[cluster ops add remove node]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/adding-removing-nodes
+[cluster ops inspect node]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/inspecting-node
+[cluster ops change info]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/changing-cluster-info
+[cluster ops load balance]: {{<baseurl>}}riak/kv/3.0.7/configuring/load-balancing-proxy
+[cluster ops bucket types]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/bucket-types
+[cluster ops handoff]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/handoff
+[cluster ops log]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/logging
+[cluster ops obj del]: {{<baseurl>}}riak/kv/3.0.7/using/reference/object-deletion
+[cluster ops backup]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/backing-up
+[cluster ops mdc]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/v3-multi-datacenter
+[cluster ops strong consistency]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/strong-consistency
+[cluster ops 2i]: {{<baseurl>}}riak/kv/3.0.7/using/reference/secondary-indexes
+[cluster ops v3 mdc]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/v3-multi-datacenter
+[cluster ops v2 mdc]: {{<baseurl>}}riak/kv/3.0.7/using/cluster-operations/v2-multi-datacenter
+
+### Repair/Recover
+
+[repair recover index]: {{<baseurl>}}riak/kv/3.0.7/using/repair-recovery
+[repair recover index]: {{<baseurl>}}riak/kv/3.0.7/using/repair-recovery/failure-recovery/
+
+### Security
+
+[security index]: {{<baseurl>}}riak/kv/3.0.7/using/security/
+[security basics]: {{<baseurl>}}riak/kv/3.0.7/using/security/basics
+[security managing]: {{<baseurl>}}riak/kv/3.0.7/using/security/managing-sources/
+
+### Performance
+
+[perf index]: {{<baseurl>}}riak/kv/3.0.7/using/performance/
+[perf benchmark]: {{<baseurl>}}riak/kv/3.0.7/using/performance/benchmarking
+[perf open files]: {{<baseurl>}}riak/kv/3.0.7/using/performance/open-files-limit/
+[perf erlang]: {{<baseurl>}}riak/kv/3.0.7/using/performance/erlang
+[perf aws]: {{<baseurl>}}riak/kv/3.0.7/using/performance/amazon-web-services
+[perf latency checklist]: {{<baseurl>}}riak/kv/3.0.7/using/performance/latency-reduction
+
+### Troubleshooting
+
+[troubleshoot http]: {{<baseurl>}}riak/kv/3.0.7/using/troubleshooting/http-204
+
+
+## Developing
+
+[dev index]: {{<baseurl>}}riak/kv/3.0.7/developing
+[dev client libraries]: {{<baseurl>}}riak/kv/3.0.7/developing/client-libraries
+[dev data model]: {{<baseurl>}}riak/kv/3.0.7/developing/data-modeling
+[dev data types]: {{<baseurl>}}riak/kv/3.0.7/developing/data-types
+[dev kv model]: {{<baseurl>}}riak/kv/3.0.7/developing/key-value-modeling
+
+### Getting Started
+
+[getting started]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started
+[getting started java]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/java
+[getting started ruby]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/ruby
+[getting started python]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/python
+[getting started php]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/php
+[getting started csharp]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/csharp
+[getting started nodejs]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/nodejs
+[getting started erlang]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/erlang
+[getting started golang]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/golang
+
+[obj model java]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/java/object-modeling
+[obj model ruby]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/ruby/object-modeling
+[obj model python]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/python/object-modeling
+[obj model csharp]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/csharp/object-modeling
+[obj model nodejs]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/nodejs/object-modeling
+[obj model erlang]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/erlang/object-modeling
+[obj model golang]: {{<baseurl>}}riak/kv/3.0.7/developing/getting-started/golang/object-modeling
+
+### Usage
+
+[usage index]: {{<baseurl>}}riak/kv/3.0.7/developing/usage
+[usage bucket types]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/bucket-types
+[usage commit hooks]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/commit-hooks
+[usage conflict resolution]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/conflict-resolution
+[usage content types]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/content-types
+[usage create objects]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/creating-objects
+[usage custom extractors]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/custom-extractors
+[usage delete objects]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/deleting-objects
+[usage mapreduce]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/mapreduce
+[usage search]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/search
+[usage search schema]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/search-schemas
+[usage search data types]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/searching-data-types
+[usage 2i]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/secondary-indexes
+[usage update objects]: {{<baseurl>}}riak/kv/3.0.7/developing/usage/updating-objects
+
+### App Guide
+
+[apps mapreduce]: {{<baseurl>}}riak/kv/3.0.7/developing/app-guide/advanced-mapreduce
+[apps replication properties]: {{<baseurl>}}riak/kv/3.0.7/developing/app-guide/replication-properties
+[apps strong consistency]: {{<baseurl>}}riak/kv/3.0.7/developing/app-guide/strong-consistency
+
+### API
+
+[dev api backend]: {{<baseurl>}}riak/kv/3.0.7/developing/api/backend
+[dev api http]: {{<baseurl>}}riak/kv/3.0.7/developing/api/http
+[dev api http status]: {{<baseurl>}}riak/kv/3.0.7/developing/api/http/status
+[dev api pbc]: {{<baseurl>}}riak/kv/3.0.7/developing/api/protocol-buffers/
+
+
+## Learn
+
+[learn new nosql]: {{<baseurl>}}riak/kv/learn/new-to-nosql
+[learn use cases]: {{<baseurl>}}riak/kv/learn/use-cases
+[learn why riak]: {{<baseurl>}}riak/kv/learn/why-riak-kv
+
+[glossary]: {{<baseurl>}}riak/kv/3.0.7/learn/glossary/
+[glossary aae]: {{<baseurl>}}riak/kv/3.0.7/learn/glossary/#active-anti-entropy-aae
+[glossary read rep]: {{<baseurl>}}riak/kv/3.0.7/learn/glossary/#read-repair
+[glossary vnode]: {{<baseurl>}}riak/kv/3.0.7/learn/glossary/#vnode
+
+[concept aae]: {{<baseurl>}}riak/kv/3.0.7/learn/concepts/active-anti-entropy/
+[concept buckets]: {{<baseurl>}}riak/kv/3.0.7/learn/concepts/buckets
+[concept cap neg]: {{<baseurl>}}riak/kv/3.0.7/learn/concepts/capability-negotiation
+[concept causal context]: {{<baseurl>}}riak/kv/3.0.7/learn/concepts/causal-context
+[concept clusters]: {{<baseurl>}}riak/kv/3.0.7/learn/concepts/clusters/
+[concept crdts]: {{<baseurl>}}riak/kv/3.0.7/learn/concepts/crdts
+[concept eventual consistency]: {{<baseurl>}}riak/kv/3.0.7/learn/concepts/eventual-consistency
+[concept keys objects]: {{<baseurl>}}riak/kv/3.0.7/learn/concepts/keys-and-objects
+[concept replication]: {{<baseurl>}}riak/kv/3.0.7/learn/concepts/replication
+[concept strong consistency]: {{<baseurl>}}riak/kv/3.0.7/using/reference/strong-consistency
+[concept vnodes]: {{<baseurl>}}riak/kv/3.0.7/learn/concepts/vnodes
+
+
+
+## Community
+
+[community]: {{<baseurl>}}community
+[community projects]: {{<baseurl>}}community/projects
+[reporting bugs]: {{<baseurl>}}community/reporting-bugs
+[taishi]: {{<baseurl>}}community/taishi
+
+
+
+
+
+
diff --git a/content/riak/kv/3.0.7/add-ons.md b/content/riak/kv/3.0.7/add-ons.md
@@ -0,0 +1,25 @@
+---
+title: "Add-ons"
+description: "Add-on technology for Riak KV"
+project: "riak_kv"
+project_version: 3.0.7
+menu:
+  riak_kv-3.0.7:
+    name: "Add-ons"
+    identifier: "add-ons"
+    weight: 400
+    pre: tools
+toc: true
+aliases:
+---
+
+
+
+In the days of Basho, integrations between Riak KV and other best-of-breed components were developed for your application stack. Each integration, called an add-on, is explained in this section, from installation to feature-set.
+
+* [Riak Redis Add-on]({{<baseurl>}}riak/kv/3.0.7/add-ons/redis/)
+
+
+
+
+
diff --git a/content/riak/kv/3.0.7/add-ons/redis.md b/content/riak/kv/3.0.7/add-ons/redis.md
@@ -0,0 +1,63 @@
+---
+title: "Riak Redis Add-on"
+description: "Redis Add-on for Riak KV"
+project: "riak_kv"
+project_version: 3.0.7
+menu:
+  riak_kv-3.0.7:
+    name: "Redis Add-on"
+    identifier: "add-ons_redis"
+    weight: 101
+    parent: "add-ons"
+toc: true
+commercial_offering: true
+aliases:
+---
+
+
+[addon redis develop]: ./developing-rra/
+[addon redis features]: ./redis-add-on-features/
+[addon redis setup]: ./set-up-rra/
+[addon redis use]: ./get-started-with-rra/
+[ee]: https://www.tiot.jp/en/about-us/contact-us/
+
+{{% note title="Warning: No longer actively maintained" %}}
+Since moving to Open Source, the Riak Redis Add-on is no longer actively maintained. As basic functionality has not changed, we expect the add-on to continue working with newer versions without incident but cannot guarantee this. The text below is left from the last known good version.
+{{% /note %}}
+
+Riak Redis Add-on (RRA) is a distributed cache service that joins the power of Redis caching with the eventual consistency guarantees of Riak KV.
+
+RRA enables you to reduce latency for Riak KV reads through the use of a distributed cache layer. This type of caching is most effective for keys that are immutable or have an infrequent change rate.
+
+Whether you are looking to build out a session, shopping cart, advertisement or other dynamically-rendered copy, RRA helps reduce read pressure on your persistent store (Riak KV).
+
+## Compatibility
+
+RRA is supported on the following platforms:
+
+* RHEL/CentOS 6
+* RHEL/CentOS 7
+* Ubuntu 12.04 LTS "Precise Pangolin"
+* Ubuntu 14.04 LTS "Trusty Tahr"
+* Debian 7 "Wheezy"
+* Debian 8 "Jessie"
+
+RRA is compatible with the following services:
+
+* Riak KV Enterprise (2.1.4+)
+* Riak TS Enterprise (1.4.0+)
+* Redis 2.x and 3.x (in 3.x, not supporting Redis Cluster)
+  * Redis Cluster and RRA's consistent hash are at odds, which surface as errors
+    such as MOVED, ASK, and CROSSSLOT messages from Redis, see (WIP):
+    https://github.com/antirez/redis-rb-cluster
+
+## Get Started
+
+* [Set up RRA.][addon redis setup]
+* [Use RRA with various clients.][addon redis use]
+* [Develop with RRA.][addon redis develop]
+* [Learn about RRA's features.][addon redis features]
+
+
+
+