Skip to content

Commit be8cf7e

Browse files
JMercerGitJMercerGit
authored
Fix for outdated references and changes to the upgrading checklist to remove basho support references (#240)
* Resolves a broken link in a few pages after riak admin changes Resolves a broken link in a few pages after riak admin changes Also closes issue #220 * Changes to the upgrading checklist to remove references to basho support Changes to the upgrading checklist to remove references to Basho support and adds both community and TI Tokyo options. Also updates example emails in SI files from basho.com to dev.com Fixes issue #219 * Adds correct exampledomain usage Adds correct exampledomain usage
1 parent ed3008e commit be8cf7e

File tree

73 files changed

+461
-495
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+461
-495
lines changed

‎content/riak/kv/2.0.0/developing/usage/secondary-indexes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ RiakObject obj = new RiakObject()
122122
.setValue(BinaryValue.create("{'user_data':{ ... }}"));
123123

124124
obj.getIndexes().getIndex(StringBinIndex.named("twitter")).add("jsmith123");
125-
obj.getIndexes().getIndex(StringBinIndex.named("email")).add("jsmith@basho.com");
125+
obj.getIndexes().getIndex(StringBinIndex.named("email")).add("jsmith@{{% exampledomain %}}");
126126

127127
StoreValue store = new StoreValue.Builder(obj)
128128
.withLocation(johnSmithKey)
@@ -138,7 +138,7 @@ obj.raw_data = '{"user_data":{ ... }}'
138138

139139
# String/binary indexes must be set as an array of strings
140140
obj.indexes['twitter_bin'] = %w{ jsmith123 }
141-
obj.indexes['email_bin'] = %w{ jsmith@basho.com }
141+
obj.indexes['email_bin'] = %w{ jsmith@{{% exampledomain %}} }
142142
obj.store
143143

144144
# In the Ruby client (and all clients), if you do not specify a bucket
@@ -153,7 +153,7 @@ obj.store
153153
```php
154154
$object = (new \Basho\Riak\Object('{"user_data":{ ... }}', ['Content-type' => 'application/json']))
155155
->addValueToIndex('twitter_bin', 'jsmith123')
156-
->addValueToIndex('email_bin', 'jsmith@basho.com');
156+
->addValueToIndex('email_bin', 'jsmith@{{% exampledomain %}}');
157157

158158
(new \Basho\Riak\Command\Builder\StoreObject($riak))
159159
->withObject($object)
@@ -173,7 +173,7 @@ obj = RiakObject(client, bucket, 'john_smith')
173173
obj.content_type = 'text/plain'
174174
obj.data = '...user data...'
175175
obj.add_index('twitter_bin', 'jsmith123')
176-
obj.add_index('email_bin', 'jsmith@basho.com')
176+
obj.add_index('email_bin', 'jsmith@{{% exampledomain %}}')
177177
obj.store()
178178
```
179179

@@ -182,7 +182,7 @@ var id = new RiakObjectId("default", "users", "john_smith");
182182
var obj = new RiakObject(id, "...user data...",
183183
RiakConstants.ContentTypes.TextPlain);
184184
obj.BinIndex("twitter").Set("jsmith123");
185-
obj.BinIndex("email").Set"jsmith@basho.com");
185+
obj.BinIndex("email").Set"jsmith@{{% exampledomain %}}");
186186
var rslt = client.Put(obj);
187187
```
188188

@@ -193,7 +193,7 @@ riakObj.setBucket('users');
193193
riakObj.setKey('john_smith');
194194
riakObj.setValue('...user data...');
195195
riakObj.addToIndex('twitter_bin', 'jsmith123');
196-
riakObj.addToIndex('email_bin', 'jsmith@basho.com');
196+
riakObj.addToIndex('email_bin', 'jsmith@{{% exampledomain %}}');
197197
client.storeValue({ value: riakObj }, function (err, rslt) {
198198
if (err) {
199199
throw new Error(err);
@@ -218,7 +218,7 @@ MD1 = riakc_obj:get_update_metadata(Obj),
218218
MD2 = riakc_obj:set_secondary_index(
219219
MD1,
220220
[{{binary_index, "twitter"}, [<<"jsmith123">>]},
221-
{{binary_index, "email"}, [<<"jsmith@basho.com">>]}]),
221+
{{binary_index, "email"}, [<<"jsmith@{{% exampledomain %}}">>]}]),
222222
Obj2 = riakc_obj:update_metadata(Obj, MD2),
223223
riakc_pb_socket:put(Pid, Obj2).
224224
```
@@ -235,7 +235,7 @@ obj := &riak.Object{
235235
}
236236

237237
obj.AddToIndex("twitter_bin", "jsmith123")
238-
obj.AddToIndex("email_bin", "jsmith@basho.com")
238+
obj.AddToIndex("email_bin", "jsmith@{{% exampledomain %}}")
239239

240240
cmd, err := riak.NewStoreValueCommandBuilder().
241241
WithContent(obj).
@@ -252,7 +252,7 @@ if err := cluster.Execute(cmd); err != nil {
252252
```curl
253253
curl -XPOST localhost:8098/types/default/buckets/users/keys/john_smith \
254254
-H 'x-riak-index-twitter_bin: jsmith123' \
255-
-H 'x-riak-index-email_bin: jsmith@basho.com' \
255+
-H 'x-riak-index-email_bin: jsmith@{{% exampledomain %}}' \
256256
-H 'Content-Type: application/json' \
257257
-d '{"userData":"data"}'
258258
```
@@ -269,7 +269,7 @@ This has accomplished the following:
269269
* The object now has a secondary index called `twitter_bin` with a value
270270
of `jsmith123`
271271
* The object now has a secondary index called `email_bin` with a value
272-
of `jsmith@basho.com`
272+
of `jsmith@{{% exampledomain %}}`
273273

274274
### Querying Objects with Secondary Indexes
275275

‎content/riak/kv/2.0.1/developing/usage/secondary-indexes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ RiakObject obj = new RiakObject()
122122
.setValue(BinaryValue.create("{'user_data':{ ... }}"));
123123

124124
obj.getIndexes().getIndex(StringBinIndex.named("twitter")).add("jsmith123");
125-
obj.getIndexes().getIndex(StringBinIndex.named("email")).add("jsmith@basho.com");
125+
obj.getIndexes().getIndex(StringBinIndex.named("email")).add("jsmith@{{% exampledomain %}}");
126126

127127
StoreValue store = new StoreValue.Builder(obj)
128128
.withLocation(johnSmithKey)
@@ -138,7 +138,7 @@ obj.raw_data = '{"user_data":{ ... }}'
138138

139139
# String/binary indexes must be set as an array of strings
140140
obj.indexes['twitter_bin'] = %w{ jsmith123 }
141-
obj.indexes['email_bin'] = %w{ jsmith@basho.com }
141+
obj.indexes['email_bin'] = %w{ jsmith@{{% exampledomain %}} }
142142
obj.store
143143

144144
# In the Ruby client (and all clients), if you do not specify a bucket
@@ -153,7 +153,7 @@ obj.store
153153
```php
154154
$object = (new \Basho\Riak\Object('{"user_data":{ ... }}', ['Content-type' => 'application/json']))
155155
->addValueToIndex('twitter_bin', 'jsmith123')
156-
->addValueToIndex('email_bin', 'jsmith@basho.com');
156+
->addValueToIndex('email_bin', 'jsmith@{{% exampledomain %}}');
157157

158158
(new \Basho\Riak\Command\Builder\StoreObject($riak))
159159
->withObject($object)
@@ -173,7 +173,7 @@ obj = RiakObject(client, bucket, 'john_smith')
173173
obj.content_type = 'text/plain'
174174
obj.data = '...user data...'
175175
obj.add_index('twitter_bin', 'jsmith123')
176-
obj.add_index('email_bin', 'jsmith@basho.com')
176+
obj.add_index('email_bin', 'jsmith@{{% exampledomain %}}')
177177
obj.store()
178178
```
179179

@@ -182,7 +182,7 @@ var id = new RiakObjectId("default", "users", "john_smith");
182182
var obj = new RiakObject(id, "...user data...",
183183
RiakConstants.ContentTypes.TextPlain);
184184
obj.BinIndex("twitter").Set("jsmith123");
185-
obj.BinIndex("email").Set"jsmith@basho.com");
185+
obj.BinIndex("email").Set"jsmith@{{% exampledomain %}}");
186186
var rslt = client.Put(obj);
187187
```
188188

@@ -193,7 +193,7 @@ riakObj.setBucket('users');
193193
riakObj.setKey('john_smith');
194194
riakObj.setValue('...user data...');
195195
riakObj.addToIndex('twitter_bin', 'jsmith123');
196-
riakObj.addToIndex('email_bin', 'jsmith@basho.com');
196+
riakObj.addToIndex('email_bin', 'jsmith@{{% exampledomain %}}');
197197
client.storeValue({ value: riakObj }, function (err, rslt) {
198198
if (err) {
199199
throw new Error(err);
@@ -218,7 +218,7 @@ MD1 = riakc_obj:get_update_metadata(Obj),
218218
MD2 = riakc_obj:set_secondary_index(
219219
MD1,
220220
[{{binary_index, "twitter"}, [<<"jsmith123">>]},
221-
{{binary_index, "email"}, [<<"jsmith@basho.com">>]}]),
221+
{{binary_index, "email"}, [<<"jsmith@{{% exampledomain %}}">>]}]),
222222
Obj2 = riakc_obj:update_metadata(Obj, MD2),
223223
riakc_pb_socket:put(Pid, Obj2).
224224
```
@@ -235,7 +235,7 @@ obj := &riak.Object{
235235
}
236236

237237
obj.AddToIndex("twitter_bin", "jsmith123")
238-
obj.AddToIndex("email_bin", "jsmith@basho.com")
238+
obj.AddToIndex("email_bin", "jsmith@{{% exampledomain %}}")
239239

240240
cmd, err := riak.NewStoreValueCommandBuilder().
241241
WithContent(obj).
@@ -252,7 +252,7 @@ if err := cluster.Execute(cmd); err != nil {
252252
```curl
253253
curl -XPOST localhost:8098/types/default/buckets/users/keys/john_smith \
254254
-H 'x-riak-index-twitter_bin: jsmith123' \
255-
-H 'x-riak-index-email_bin: jsmith@basho.com' \
255+
-H 'x-riak-index-email_bin: jsmith@{{% exampledomain %}}' \
256256
-H 'Content-Type: application/json' \
257257
-d '{"userData":"data"}'
258258
```
@@ -269,7 +269,7 @@ This has accomplished the following:
269269
* The object now has a secondary index called `twitter_bin` with a value
270270
of `jsmith123`
271271
* The object now has a secondary index called `email_bin` with a value
272-
of `jsmith@basho.com`
272+
of `jsmith@{{% exampledomain %}}`
273273

274274
### Querying Objects with Secondary Indexes
275275

‎content/riak/kv/2.0.2/developing/usage/secondary-indexes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ RiakObject obj = new RiakObject()
121121
.setValue(BinaryValue.create("{'user_data':{ ... }}"));
122122

123123
obj.getIndexes().getIndex(StringBinIndex.named("twitter")).add("jsmith123");
124-
obj.getIndexes().getIndex(StringBinIndex.named("email")).add("jsmith@basho.com");
124+
obj.getIndexes().getIndex(StringBinIndex.named("email")).add("jsmith@{{% exampledomain %}}");
125125

126126
StoreValue store = new StoreValue.Builder(obj)
127127
.withLocation(johnSmithKey)
@@ -137,7 +137,7 @@ obj.raw_data = '{"user_data":{ ... }}'
137137

138138
# String/binary indexes must be set as an array of strings
139139
obj.indexes['twitter_bin'] = %w{ jsmith123 }
140-
obj.indexes['email_bin'] = %w{ jsmith@basho.com }
140+
obj.indexes['email_bin'] = %w{ jsmith@{{% exampledomain %}} }
141141
obj.store
142142

143143
# In the Ruby client (and all clients), if you do not specify a bucket
@@ -152,7 +152,7 @@ obj.store
152152
```php
153153
$object = (new \Basho\Riak\Object('{"user_data":{ ... }}', ['Content-type' => 'application/json']))
154154
->addValueToIndex('twitter_bin', 'jsmith123')
155-
->addValueToIndex('email_bin', 'jsmith@basho.com');
155+
->addValueToIndex('email_bin', 'jsmith@{{% exampledomain %}}');
156156

157157
(new \Basho\Riak\Command\Builder\StoreObject($riak))
158158
->withObject($object)
@@ -172,7 +172,7 @@ obj = RiakObject(client, bucket, 'john_smith')
172172
obj.content_type = 'text/plain'
173173
obj.data = '...user data...'
174174
obj.add_index('twitter_bin', 'jsmith123')
175-
obj.add_index('email_bin', 'jsmith@basho.com')
175+
obj.add_index('email_bin', 'jsmith@{{% exampledomain %}}')
176176
obj.store()
177177
```
178178

@@ -181,7 +181,7 @@ var id = new RiakObjectId("default", "users", "john_smith");
181181
var obj = new RiakObject(id, "...user data...",
182182
RiakConstants.ContentTypes.TextPlain);
183183
obj.BinIndex("twitter").Set("jsmith123");
184-
obj.BinIndex("email").Set"jsmith@basho.com");
184+
obj.BinIndex("email").Set"jsmith@{{% exampledomain %}}");
185185
var rslt = client.Put(obj);
186186
```
187187

@@ -192,7 +192,7 @@ riakObj.setBucket('users');
192192
riakObj.setKey('john_smith');
193193
riakObj.setValue('...user data...');
194194
riakObj.addToIndex('twitter_bin', 'jsmith123');
195-
riakObj.addToIndex('email_bin', 'jsmith@basho.com');
195+
riakObj.addToIndex('email_bin', 'jsmith@{{% exampledomain %}}');
196196
client.storeValue({ value: riakObj }, function (err, rslt) {
197197
if (err) {
198198
throw new Error(err);
@@ -217,7 +217,7 @@ MD1 = riakc_obj:get_update_metadata(Obj),
217217
MD2 = riakc_obj:set_secondary_index(
218218
MD1,
219219
[{{binary_index, "twitter"}, [<<"jsmith123">>]},
220-
{{binary_index, "email"}, [<<"jsmith@basho.com">>]}]),
220+
{{binary_index, "email"}, [<<"jsmith@{{% exampledomain %}}">>]}]),
221221
Obj2 = riakc_obj:update_metadata(Obj, MD2),
222222
riakc_pb_socket:put(Pid, Obj2).
223223
```
@@ -234,7 +234,7 @@ obj := &riak.Object{
234234
}
235235

236236
obj.AddToIndex("twitter_bin", "jsmith123")
237-
obj.AddToIndex("email_bin", "jsmith@basho.com")
237+
obj.AddToIndex("email_bin", "jsmith@{{% exampledomain %}}")
238238

239239
cmd, err := riak.NewStoreValueCommandBuilder().
240240
WithContent(obj).
@@ -251,7 +251,7 @@ if err := cluster.Execute(cmd); err != nil {
251251
```curl
252252
curl -XPOST localhost:8098/types/default/buckets/users/keys/john_smith \
253253
-H 'x-riak-index-twitter_bin: jsmith123' \
254-
-H 'x-riak-index-email_bin: jsmith@basho.com' \
254+
-H 'x-riak-index-email_bin: jsmith@{{% exampledomain %}}' \
255255
-H 'Content-Type: application/json' \
256256
-d '{"userData":"data"}'
257257
```
@@ -268,7 +268,7 @@ This has accomplished the following:
268268
* The object now has a secondary index called `twitter_bin` with a value
269269
of `jsmith123`
270270
* The object now has a secondary index called `email_bin` with a value
271-
of `jsmith@basho.com`
271+
of `jsmith@{{% exampledomain %}}`
272272

273273
### Querying Objects with Secondary Indexes
274274

‎content/riak/kv/2.0.4/developing/usage/secondary-indexes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ RiakObject obj = new RiakObject()
122122
.setValue(BinaryValue.create("{'user_data':{ ... }}"));
123123

124124
obj.getIndexes().getIndex(StringBinIndex.named("twitter")).add("jsmith123");
125-
obj.getIndexes().getIndex(StringBinIndex.named("email")).add("jsmith@basho.com");
125+
obj.getIndexes().getIndex(StringBinIndex.named("email")).add("jsmith@{{% exampledomain %}}");
126126

127127
StoreValue store = new StoreValue.Builder(obj)
128128
.withLocation(johnSmithKey)
@@ -138,7 +138,7 @@ obj.raw_data = '{"user_data":{ ... }}'
138138

139139
# String/binary indexes must be set as an array of strings
140140
obj.indexes['twitter_bin'] = %w{ jsmith123 }
141-
obj.indexes['email_bin'] = %w{ jsmith@basho.com }
141+
obj.indexes['email_bin'] = %w{ jsmith@{{% exampledomain %}} }
142142
obj.store
143143

144144
# In the Ruby client (and all clients), if you do not specify a bucket
@@ -153,7 +153,7 @@ obj.store
153153
```php
154154
$object = (new \Basho\Riak\Object('{"user_data":{ ... }}', ['Content-type' => 'application/json']))
155155
->addValueToIndex('twitter_bin', 'jsmith123')
156-
->addValueToIndex('email_bin', 'jsmith@basho.com');
156+
->addValueToIndex('email_bin', 'jsmith@{{% exampledomain %}}');
157157

158158
(new \Basho\Riak\Command\Builder\StoreObject($riak))
159159
->withObject($object)
@@ -173,7 +173,7 @@ obj = RiakObject(client, bucket, 'john_smith')
173173
obj.content_type = 'text/plain'
174174
obj.data = '...user data...'
175175
obj.add_index('twitter_bin', 'jsmith123')
176-
obj.add_index('email_bin', 'jsmith@basho.com')
176+
obj.add_index('email_bin', 'jsmith@{{% exampledomain %}}')
177177
obj.store()
178178
```
179179

@@ -182,7 +182,7 @@ var id = new RiakObjectId("default", "users", "john_smith");
182182
var obj = new RiakObject(id, "...user data...",
183183
RiakConstants.ContentTypes.TextPlain);
184184
obj.BinIndex("twitter").Set("jsmith123");
185-
obj.BinIndex("email").Set"jsmith@basho.com");
185+
obj.BinIndex("email").Set"jsmith@{{% exampledomain %}}");
186186
var rslt = client.Put(obj);
187187
```
188188

@@ -193,7 +193,7 @@ riakObj.setBucket('users');
193193
riakObj.setKey('john_smith');
194194
riakObj.setValue('...user data...');
195195
riakObj.addToIndex('twitter_bin', 'jsmith123');
196-
riakObj.addToIndex('email_bin', 'jsmith@basho.com');
196+
riakObj.addToIndex('email_bin', 'jsmith@{{% exampledomain %}}');
197197
client.storeValue({ value: riakObj }, function (err, rslt) {
198198
if (err) {
199199
throw new Error(err);
@@ -218,7 +218,7 @@ MD1 = riakc_obj:get_update_metadata(Obj),
218218
MD2 = riakc_obj:set_secondary_index(
219219
MD1,
220220
[{{binary_index, "twitter"}, [<<"jsmith123">>]},
221-
{{binary_index, "email"}, [<<"jsmith@basho.com">>]}]),
221+
{{binary_index, "email"}, [<<"jsmith@{{% exampledomain %}}">>]}]),
222222
Obj2 = riakc_obj:update_metadata(Obj, MD2),
223223
riakc_pb_socket:put(Pid, Obj2).
224224
```
@@ -235,7 +235,7 @@ obj := &riak.Object{
235235
}
236236

237237
obj.AddToIndex("twitter_bin", "jsmith123")
238-
obj.AddToIndex("email_bin", "jsmith@basho.com")
238+
obj.AddToIndex("email_bin", "jsmith@{{% exampledomain %}}")
239239

240240
cmd, err := riak.NewStoreValueCommandBuilder().
241241
WithContent(obj).
@@ -252,7 +252,7 @@ if err := cluster.Execute(cmd); err != nil {
252252
```curl
253253
curl -XPOST localhost:8098/types/default/buckets/users/keys/john_smith \
254254
-H 'x-riak-index-twitter_bin: jsmith123' \
255-
-H 'x-riak-index-email_bin: jsmith@basho.com' \
255+
-H 'x-riak-index-email_bin: jsmith@{{% exampledomain %}}' \
256256
-H 'Content-Type: application/json' \
257257
-d '{"userData":"data"}'
258258
```
@@ -269,7 +269,7 @@ This has accomplished the following:
269269
* The object now has a secondary index called `twitter_bin` with a value
270270
of `jsmith123`
271271
* The object now has a secondary index called `email_bin` with a value
272-
of `jsmith@basho.com`
272+
of `jsmith@{{% exampledomain %}}`
273273

274274
### Querying Objects with Secondary Indexes
275275

0 commit comments

Comments
 (0)