Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General doc updates #276

Merged
merged 14 commits into from
Dec 13, 2024
Merged

General doc updates #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
9dead9f
Merge dev into master (#238)
pjaclark Nov 24, 2023
1b0bf32
Merge changes between dev and master
pjaclark Dec 15, 2023
e35cca3
Remove duplicate (#260)
pjaclark Dec 15, 2023
8a47bdd
Remove duplicate (#261)
pjaclark Dec 22, 2023
f20d6f8
Fix merge conflicts
pjaclark Dec 22, 2023
ff6f648
Update Dockerfile
pjaclark Mar 18, 2024
059c0ee
Update Alpine install instructions
JMercerGit Apr 11, 2024
3f47327
Updates deprecated mount option for performance configuration
JMercerGit Apr 17, 2024
0ffbe12
Fixes duplicate section of CRUD docs for Java
JMercerGit May 1, 2024
8a5d61d
Merge branch 'TI-Tokyo:master' into JM-general-updates
JMercerGit May 1, 2024
f7368d3
Adds a note about OTP versions for CS and KV
JMercerGit May 1, 2024
3c1ca39
Merge branch 'JM-general-updates' of https://github.com/JMercerGit/ri…
JMercerGit May 1, 2024
2c97fdf
Update Release notes to correct a mistaken version number in a link
JMercerGit May 1, 2024
9279847
Updating install files to remove references to installing source pack…
JMercerGit May 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions content/riak/cs/2.1.2/cookbooks/installing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ is built
We strongly recommend using one of the documented [version combinations]({{<baseurl>}}riak/cs/2.1.2/cookbooks/version-compatibility/)
when installing and running Riak CS.

>**Note on OTP version**
>
> **If version of OTP installed with Riak CS is a higher version then the OTP version installed with Riak KV a failure to read BEAM file will occur, therefore it should be ensured that the OTP versions match.

## Installing Riak KV

Before installing Riak CS, Riak KV must be installed on each node in
Expand Down
4 changes: 4 additions & 0 deletions content/riak/cs/3.0.0/cookbooks/installing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ is built
We strongly recommend using one of the documented [version combinations]({{<baseurl>}}riak/cs/3.0.0/cookbooks/version-compatibility/)
when installing and running Riak CS.

>**Note on OTP version**
>
> **If version of OTP installed with Riak CS is a higher version then the OTP version installed with Riak KV a failure to read BEAM file will occur, therefore it should be ensured that the OTP versions match.

## Installing Riak KV

Before installing Riak CS, Riak KV must be installed on each node in
Expand Down
4 changes: 4 additions & 0 deletions content/riak/cs/3.0.1/cookbooks/installing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ is built
We strongly recommend using one of the documented [version combinations]({{<baseurl>}}riak/cs/3.0.1/cookbooks/version-compatibility/)
when installing and running Riak CS.

>**Note on OTP version**
>
> **If version of OTP installed with Riak CS is a higher version then the OTP version installed with Riak KV a failure to read BEAM file will occur, therefore it should be ensured that the OTP versions match.

## Installing Riak KV

Before installing Riak CS, Riak KV must be installed on each node in
Expand Down
18 changes: 0 additions & 18 deletions content/riak/kv/2.2.0/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.2.0/developing/usage/updatin
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.2.0/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.2.0/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.2.0/developing/usage/conflict-resolution/)
documentation.

## Deleting Objects

Now that we've stored and then fetched the object, we can delete it by
Expand Down
18 changes: 0 additions & 18 deletions content/riak/kv/2.2.1/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.2.1/developing/usage/updatin
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.2.1/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.2.1/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.2.1/developing/usage/conflict-resolution/)
documentation.

## Deleting Objects

Now that we've stored and then fetched the object, we can delete it by
Expand Down
18 changes: 0 additions & 18 deletions content/riak/kv/2.2.2/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.2.2/developing/usage/updatin
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.2.2/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.2.2/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.2.2/developing/usage/conflict-resolution/)
documentation.

## Deleting Objects

Now that we've stored and then fetched the object, we can delete it by
Expand Down
18 changes: 0 additions & 18 deletions content/riak/kv/2.2.3/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.2.3/developing/usage/updatin
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.2.3/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.2.3/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.2.3/developing/usage/conflict-resolution/)
documentation.

## Deleting Objects

Now that we've stored and then fetched the object, we can delete it by
Expand Down
2 changes: 1 addition & 1 deletion content/riak/kv/2.2.3/release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ In fixing a `riak` and `riak-admin` [issue](https://github.com/basho/node_packag

## Previous Release Notes

Please see the KV 2.2.2 release notes [here]({{<baseurl>}}riak/kv/2.2.3/release-notes/), and the KV 2.2.1 release notes [here]({{<baseurl>}}riak/kv/2.2.3/release-notes/).
Please see the KV 2.2.2 release notes [here]({{<baseurl>}}riak/kv/2.2.2/release-notes/), and the KV 2.2.1 release notes [here]({{<baseurl>}}riak/kv/2.2.1/release-notes/).
18 changes: 0 additions & 18 deletions content/riak/kv/2.2.6/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.2.6/developing/usage/updatin
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.2.6/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.2.6/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.2.6/developing/usage/conflict-resolution/)
documentation.

## Deleting Objects

Now that we've stored and then fetched the object, we can delete it by
Expand Down
18 changes: 0 additions & 18 deletions content/riak/kv/2.9.0p5/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,24 +82,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.0p5/developing/usage/updat
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.0p5/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.0p5/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.0p5/developing/usage/conflict-resolution/)
documentation.

## Deleting Objects

Now that we've stored and then fetched the object, we can delete it by
Expand Down
4 changes: 1 addition & 3 deletions content/riak/kv/2.9.0p5/using/performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,7 @@ multiple nodes holding the same data, these two options can be changed
to boost I/O performance. We recommend setting `barrier=0` and
`data=writeback` when using the ext4 filesystem.

Similarly, the XFS file system defaults can be optimized to improve
performance. We recommend setting `nobarrier`, `logbufs=8`,
`logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
Similarly, the XFS file system defaults can be optimized to improve performance. We recommend setting `logbufs=8`, `logbsize=256k`, and `allocsize=2M` when using the XFS filesystem. In addition, up to Ubuntu 17.10 and RHEL/CentOS 7.9 (and any OS using a Linux kernel before 4.15) we recommend setting `nobarrier`.

As with the `noatime` setting, these settings should be added to
`/etc/fstab` so that they are persisted across server restarts.
Expand Down
18 changes: 0 additions & 18 deletions content/riak/kv/2.9.1/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.1/developing/usage/updatin
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.1/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.1/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.1/developing/usage/conflict-resolution/)
documentation.

## Deleting Objects

Now that we've stored and then fetched the object, we can delete it by
Expand Down
6 changes: 3 additions & 3 deletions content/riak/kv/2.9.1/using/performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@ multiple nodes holding the same data, these two options can be changed
to boost I/O performance. We recommend setting `barrier=0` and
`data=writeback` when using the ext4 filesystem.

Similarly, the XFS file system defaults can be optimized to improve
performance. We recommend setting `nobarrier`, `logbufs=8`,
`logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
Similarly, the XFS file system defaults can be optimized to improve performance.
We recommend setting `logbufs=8`, `logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
In addition, up to Ubuntu 17.10 and RHEL/CentOS 7.9 (and any OS using a Linux kernel before 4.15) we recommend setting `nobarrier`.

As with the `noatime` setting, these settings should be added to
`/etc/fstab` so that they are persisted across server restarts.
Expand Down
18 changes: 0 additions & 18 deletions content/riak/kv/2.9.10/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.10/developing/usage/updati
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.10/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.10/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.10/developing/usage/conflict-resolution/)
documentation.

## Deleting Objects

Now that we've stored and then fetched the object, we can delete it by
Expand Down
6 changes: 3 additions & 3 deletions content/riak/kv/2.9.10/using/performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@ multiple nodes holding the same data, these two options can be changed
to boost I/O performance. We recommend setting `barrier=0` and
`data=writeback` when using the ext4 filesystem.

Similarly, the XFS file system defaults can be optimized to improve
performance. We recommend setting `nobarrier`, `logbufs=8`,
`logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
Similarly, the XFS file system defaults can be optimized to improve performance.
We recommend setting `logbufs=8`, `logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
In addition, up to Ubuntu 17.10 and RHEL/CentOS 7.9 (and any OS using a Linux kernel before 4.15) we recommend setting `nobarrier`.

As with the `noatime` setting, these settings should be added to
`/etc/fstab` so that they are persisted across server restarts.
Expand Down
18 changes: 0 additions & 18 deletions content/riak/kv/2.9.2/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.2/developing/usage/updatin
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.2/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.2/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.2/developing/usage/conflict-resolution/)
documentation.

## Deleting Objects

Now that we've stored and then fetched the object, we can delete it by
Expand Down
6 changes: 3 additions & 3 deletions content/riak/kv/2.9.2/using/performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@ multiple nodes holding the same data, these two options can be changed
to boost I/O performance. We recommend setting `barrier=0` and
`data=writeback` when using the ext4 filesystem.

Similarly, the XFS file system defaults can be optimized to improve
performance. We recommend setting `nobarrier`, `logbufs=8`,
`logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
Similarly, the XFS file system defaults can be optimized to improve performance.
We recommend setting `logbufs=8`, `logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
In addition, up to Ubuntu 17.10 and RHEL/CentOS 7.9 (and any OS using a Linux kernel before 4.15) we recommend setting `nobarrier`.

As with the `noatime` setting, these settings should be added to
`/etc/fstab` so that they are persisted across server restarts.
Expand Down
18 changes: 0 additions & 18 deletions content/riak/kv/2.9.4/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.4/developing/usage/updatin
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.4/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.4/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.4/developing/usage/conflict-resolution/)
documentation.

## Deleting Objects

Now that we've stored and then fetched the object, we can delete it by
Expand Down
6 changes: 3 additions & 3 deletions content/riak/kv/2.9.4/using/performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@ multiple nodes holding the same data, these two options can be changed
to boost I/O performance. We recommend setting `barrier=0` and
`data=writeback` when using the ext4 filesystem.

Similarly, the XFS file system defaults can be optimized to improve
performance. We recommend setting `nobarrier`, `logbufs=8`,
`logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
Similarly, the XFS file system defaults can be optimized to improve performance.
We recommend setting `logbufs=8`, `logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
In addition, up to Ubuntu 17.10 and RHEL/CentOS 7.9 (and any OS using a Linux kernel before 4.15) we recommend setting `nobarrier`.

As with the `noatime` setting, these settings should be added to
`/etc/fstab` so that they are persisted across server restarts.
Expand Down
13 changes: 0 additions & 13 deletions content/riak/kv/2.9.7/developing/getting-started/java/crud-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,19 +75,6 @@ Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.7/developing/usage/updatin
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.7/developing/usage/conflict-resolution/)
documentation.

## Updating Objects

Once we've read the object back in from Riak, we can update the object
and store it back as we did before with the `StoreValue` object:

```java
fetchedObject.setValue(BinaryValue.create("You can be my wingman any time."));
StoreValue updateOp = new StoreValue.Builder(fetchedObject)
.withLocation(quoteObjectLocation)
.build();
StoreValue.Response updateOpResp = client.execute(updateOp);
```

For more in depth information on updating objects and sibling resolution in
Riak, see [Updating Objects]({{<baseurl>}}riak/kv/2.9.7/developing/usage/updating-objects/)
and [Conflict Resolution]({{<baseurl>}}riak/kv/2.9.7/developing/usage/conflict-resolution/)
Expand Down
6 changes: 3 additions & 3 deletions content/riak/kv/2.9.7/using/performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@ multiple nodes holding the same data, these two options can be changed
to boost I/O performance. We recommend setting `barrier=0` and
`data=writeback` when using the ext4 filesystem.

Similarly, the XFS file system defaults can be optimized to improve
performance. We recommend setting `nobarrier`, `logbufs=8`,
`logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
Similarly, the XFS file system defaults can be optimized to improve performance.
We recommend setting `logbufs=8`, `logbsize=256k`, and `allocsize=2M` when using the XFS filesystem.
In addition, up to Ubuntu 17.10 and RHEL/CentOS 7.9 (and any OS using a Linux kernel before 4.15) we recommend setting `nobarrier`.

As with the `noatime` setting, these settings should be added to
`/etc/fstab` so that they are persisted across server restarts.
Expand Down
Loading