- Based on https://codeberg.org/redict/redict-doc
- Adjusted for Hugo
- Removed references to proprietary extensions from Redis
- Clean up
Add documentation for data types #15
* Based on https://codeberg.org/redict/redict-doc * Adjusted for Hugo * Removed references to proprietary extensions from Redis * Clean up
Nice work!
@ -0,0 +4,4 @@
linkTitle: "Data Types"
description: Overview of data types supported by Redict
weight: 4
---
Can you remove unused fields (e.g. linkTitle and description)?
This should also have a shorter name so it doesn't stick out so sorely in the navigation: "Data types"?
Both fields are used. linkTitle is the title used in the navigation. This is how the navigation looks like on this branch:
The navigation features short titles like "Data Types"
The description field is also used for the meta description:
<meta name="description" content="Overview of data types supported by Redict">
@ -0,0 +8,4 @@
# Understanding Redict Data Types
Redict is a data structure server. At its core, Redict provides a collection of native data types that help you solve a wide variety of problems, from [caching](/docs/manual/client-side-caching/) to [queuing](/docs/data-types/lists/) to [event processing](/docs/data-types/streams/). Below is a short description of each data type, with links to broader overviews and command references.
I ran into this with the scripting docs as well, but we have some links like this which lead to content that does not exist on redict.io. Should we just leave it here and do another pass over all of the links once we finish importing everything we intend to bring in from redict-doc?
Yes, I think we should port over the content, and then run a dead link checker on the entire site.
@ -0,0 +106,4 @@
## Learn more
* [Redis Bitmaps Explained](https://www.youtube.com/watch?v=oj8LdJQjhJo) teaches you how to use bitmaps for map exploration in an online game.
* [Redis University's RU101](https://university.redis.com/courses/ru101/) covers Redis bitmaps in detail.
I don't think we should lead into Redis content unless we have to (e.g. by referencing the RESP specification).
Works for me! I will remove all links to their YouTube channel and University.
@ -0,0 +203,4 @@
implement background jobs.
The popular Twitter social network [takes the latest tweets](http://www.infoq.com/presentations/Real-Time-Delivery-Twitter)
posted by users into Redict lists.
nit: these presumably still use Redis and/or may use another fork, perhaps we shouldn't boldly claim that they use Redict lists for their use-cases?
I guess the same is true for:
For example both the popular Ruby libraries resque and sidekiq use Redict lists under the hood in order to implement background jobs.
@ -0,0 +142,4 @@
### Lexicographical scores
In version Redict 2.8, a new feature was introduced that allows
Do a quick sweep for non-existent Redict versions. Use your discretion to either rewrite to say "since Redis x.y", or remove it entirely as the old usage is obsolete for Redict users.
Done!
@ -0,0 +114,4 @@
To perform bitwise operations on a string, see the [bitmaps data type](/docs/data-types/bitmaps) docs.
See the [complete list of string commands](/commands/?group=string).
I don't think this ?group=whatever thing works on our command list page
You are right, I rewrote a few, but seem to have missed this one! Good catch 👍
@ -2,3 +2,3 @@
title: Scripting Redict with Lua
bookCollapseSection: true
weight: 4
weight: 5
These can both share a weight of 4 and they'll just be alpha-sorted, which will have the same effect and won't require as much finagling as we add more content.
Yes. Maybe we can briefly decide the order of the navigation, including the upcoming "Usage" section discussed in #15. I propose:
- Installation
- Command Reference
- Data Types
- Usage
- Clients
- Modules
- Scripting with Lua
- Compatability with Redis
- Community Resources
- About the license
- Source Code
- Blog
If that works for you, I will adjust the weights in this PR.
I think Usage should come immediately after Installation but otherwise I agree with this ordering.
* Remove links to Redis YouTube and University * For external tools that use Redis, do not claim they use Redict * Fix the heading structure * Remove references to old versions of Redis
Approved pending weight adjustements
Can you make the weights powers of ten so that we can more easily add stuff between them without having to renumber everything?
Adjusted the order in the navigation, it looks like this now:
Hm? That ordering is not consistent with my suggestion earlier.
To me, the "Redict Modules" should be "Modules" and "Scripting Redict with Lua" should be "Scripting with Lua" in the navigation. What do you think?
@ddevault Sorry, I did not see that comment. Will adjust it 👍
Thanks!
Adjusted:
- Weights * 10
- Order as suggested
- Drop "Redict" from the link titles in the navigation
Sorry, I thought you said you would re-adjust them in a follow-up pull request. Can you do that?
@ddevault Yep, coming up 👍
Something is not working
Contributions are very welcome, get started here
This issue or pull request already exists
New feature
Interested in contributing? Get started here.
Need some help
Something is wrong
More information is needed
Related to an upstream repository, already reported there
No due date set.
No dependencies set.
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?