tobyhferguson / aws-microservices-workshop Goto Github PK

For each Redis Streams reference make sure its canonicalized and linked to the underlying docs.

https://redis.io/topics/streams-intro

Change the first paragraph to introduce the 'faceted search' term directly, not just appealing to the heading.

In the current release (v0.1-alpha) the setup requires maven, java, git, docker, docker-compose - it would be good to reduce this to the absolute minimum (docker/docker-compose?) so as to reduce the setup.

Alternatively, we might choose to offer multiple different methods, starting from the build it all approach to the minimalist, including K8S and/or ECS

convert:

line 1) defines the attribute name index name”,

to

line 1) defines the attribute name index name,

The font size on the numbered list seems very wrong - how can I fix it?

The Workshop should flow linearly; at the same time we should allow for non-linear learning; for a learner to pick and choose, and to start/stop as they see fit. Therefore its important that the self-contained pieces that should be completed in one sitting be marked as such, but that everything else be able to be broken up.

How do we decided what should go as a chapter, and what should go as a page? I think the current layout is a bit random, with some chapters being very short, with many subsections, and others much longer.

I think, stylistically, we want to be consistent so that users know what to expect

from:

To find a specific record a user has to scroll through the pages which is both tedious and error-prone.

to

To find a specific record a user has to scroll through the pages; an action which is both tedious and error-prone.

In Redisinsight 1.7.1 the index is incorrectly shown as ending in a colon. If this is cut and pasted into the CLI it won't work - you need to remove the trailing colon.

change 2099 to 2020 - the app doesn't handle years above 2020

Explain how to get a key and/or link directly to the key url

Give instructions to select the correct index (movies, not actors)

Provide a link to the application as well as a graphic so that users know they've installed everything successfully

Link this paragraph:

By feeding these changes into Redis Streams they are made available for processing in a variety of ways, which will provide the value added benefits above.

to the previous page

Wherever the string RedisInsight is mentioned then link to it, using localhost:8001

Change

index definition is at position 6

to

index definition is at position 5

The first paragraph is soo clunky - it needs rewriting to be clearer.

This would eliminate an install step and you just point your browser at the daemon.

Link to:

• redislabs docs
• redis.io
• redisinsight

It is not our intent to teach your Redis, make you a Redis expert, or cover all of Redis. We don’t expect you to be a SpringBoot aficionado or a Java guru. Redis can be used with dozens (60+ at last count) of languages, so you can continue to do what you do well in the language of your choosing. The idea here is to get you excited and interested to learn more about using Redis

Perfect place to reference RedisU

There are a few places where images could be usefully added. We should do so.

What the Streams section doesn't do is really dig into Consumer Groups - I should add something that explains a bit about Consumer Groups, what they do, and how they work in the context of this application.

in the v0.1-alpha release the chapters 'Setup', 'Basic Flow' and 'Redis Caching' all have different heading styles. They should be consistent across the entire workshop.

The chapter intro is a bit weak - it should be stronger, describing how we'll demonstrate the caching use case, and point out another feature which has its own application area: resource management.

Add a paragraph explaining how we'll use Redisinsight, and that instructions to use it will always assume you've clicked on the database redis-service

Show images for the two slider positions

Provide a screen showing what Redisinsight looks like when its correctly installed, configured and running.

The Home page should be a summary, maybe a ToC, and then the other parts (learning objectives, prerequisites) should be separate sections.

How do I turn the green button image into a small icon sized image?

Rather than simply reference the application link to it as much as possible, allowing users to navigate quickly from the docs to the actual applicaiton.

Correct from:

ft.suggest ms:search:suggest:movies th

to

ft.sugget ms:search:suggest:movies th

Change the well documented elsewhere into a link

Get the filter icon to be small, and inline with the text

Rewrite this paragraph:

But how do we know what suggest dictionary to use, or what suggestion dictionaries exist in Redis. In this particular case, because Tug Grall, the author of this application, named the dictionary well it’s relatively easy to find it but, in general, there isn’t a command to list the suggestion dictionaries.

thus:

But how do we know what suggest dictionary to use, or what suggestion dictionaries exist in Redis? in general, there isn’t a command to list the suggestion dictionaries however, in this particular case Tug Grall (the author of this application) named the dictionary well making it relatively easy to find it. Thanks Tug!