Skip to content

Commit

Permalink
Cleanup: Delete frontmatter keys 'aliases' and 'weight' (#118)
Browse files Browse the repository at this point in the history
These frontmatter metadata keys are not useful to keep. They are
leftovers from Redis website toolchain.

Deleted using

    cd topics
perl -i -ne '$on = 1 if !$on && /^aliases: *\[/; print if !$on; $on = 0
if $on && /^ *\]/' *.md
perl -i -ne '$on = 0 if $on && !/^ /; $on = 1 if !$on && /^aliases:/;
print if !$on' *.md
    perl -i -ne 'print unless /^weight: *\d+/' *.md

Signed-off-by: Viktor Söderqvist <viktor.soderqvist@est.tech>
  • Loading branch information
zuiderkwast authored Jun 18, 2024
1 parent a18bd47 commit b4afbed
Show file tree
Hide file tree
Showing 71 changed files with 0 additions and 269 deletions.
3 changes: 0 additions & 3 deletions topics/ARM.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
---
title: "ARM support"
linkTitle: "ARM support"
weight: 11
description: >
Exploring Valkey on the ARM CPU Architecture
aliases:
- /topics/ARM
---

Valkey supports the ARM processor, for example
Expand Down
6 changes: 0 additions & 6 deletions topics/acl.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
---
title: "ACL"
linkTitle: "ACL"
weight: 1
description: Valkey Access Control List
aliases: [
/topics/acl,
/docs/manual/security/acl,
/docs/manual/security/acl.md
]
---

The Valkey ACL, short for Access Control List, is a feature that allows certain connections to be limited in terms of the commands that can be executed and the keys that can be accessed.
Expand Down
7 changes: 0 additions & 7 deletions topics/admin.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
---
title: Valkey administration
linkTitle: Administration
weight: 1
description: Advice for configuring and managing Valkey in production
aliases: [
/topics/admin,
/topics/admin.md,
/manual/admin,
/manual/admin.md
]
---

## Valkey setup tips
Expand Down
6 changes: 0 additions & 6 deletions topics/benchmark.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
---
title: "Valkey benchmark"
linkTitle: "Benchmarking"
weight: 1
description: >
Using the valkey-benchmark utility on a Valkey server
aliases: [
/topics/benchmarks,
/docs/reference/optimization/benchmarks,
/docs/reference/optimization/benchmarks.md
]
---

## Usage
Expand Down
1 change: 0 additions & 1 deletion topics/bitfields.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Bitfields"
linkTitle: "Bitfields"
weight: 130
description: >
Introduction to Bitfields
---
Expand Down
1 change: 0 additions & 1 deletion topics/bitmaps.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Bitmaps"
linkTitle: "Bitmaps"
weight: 120
description: >
Introduction to Bitmaps
---
Expand Down
5 changes: 0 additions & 5 deletions topics/cli.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
title: "Valkey CLI"
linkTitle: "CLI"
weight: 1
description: >
Valkey command line interface
aliases:
- /docs/manual/cli
- /docs/management/cli
- /docs/ui/cli
---

## Usage
Expand Down
3 changes: 0 additions & 3 deletions topics/client-side-caching.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
---
title: "Client-side caching in Valkey"
linkTitle: "Client-side caching"
weight: 2
description: >
Server-assisted, client-side caching in Valkey
aliases:
- /topics/client-side-caching
---

Client-side caching is a technique used to create high performance services.
Expand Down
3 changes: 0 additions & 3 deletions topics/clients.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
---
title: "Valkey client handling"
linkTitle: "Client handling"
weight: 5
description: >
How the Valkey server manages client connections
aliases:
- /topics/clients
---

This document provides information about how Valkey handles clients at the network layer level: connections, timeouts, buffers, and other similar topics are covered here.
Expand Down
3 changes: 0 additions & 3 deletions topics/cluster-spec.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
---
title: Valkey cluster specification
linkTitle: Cluster spec
weight: 9
description: >
Detailed specification for Valkey cluster
aliases:
- /topics/cluster-spec
---

Welcome to the **Valkey Cluster Specification**. Here you'll find information
Expand Down
7 changes: 0 additions & 7 deletions topics/cluster-tutorial.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
---
title: Scale with Valkey Cluster
linkTitle: Scale with Valkey Cluster
weight: 6
description: Horizontal scaling with Valkey Cluster
aliases: [
/topics/cluster-tutorial,
/topics/partitioning,
/docs/manual/scaling,
/docs/manual/scaling.md
]
---

Valkey scales horizontally with a deployment topology called Valkey Cluster.
Expand Down
3 changes: 0 additions & 3 deletions topics/command-arguments.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Valkey command arguments"
linkTitle: "Command arguments"
weight: 7
description: How Valkey commands expose their documentation programmatically
aliases:
- /topics/command-arguments
---

The `COMMAND DOCS` command returns documentation-focused information about available Valkey commands.
Expand Down
3 changes: 0 additions & 3 deletions topics/command-tips.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Valkey command tips"
linkTitle: "Command tips"
weight: 1
description: Get additional information about a command
aliases:
- /topics/command-tips
---

Command tips are an array of strings.
Expand Down
5 changes: 0 additions & 5 deletions topics/data-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,6 @@
title: "Valkey data types"
linkTitle: "Data types"
description: Overview of data types supported by Valkey
weight: 35
aliases:
- /docs/manual/data-types
- /topics/data-types
- /docs/data-types/tutorial
---

Valkey is a data structure server.
Expand Down
6 changes: 0 additions & 6 deletions topics/debugging.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
---
title: "Debugging"
linkTitle: "Debugging"
weight: 10
description: >
A guide to debugging Valkey server processes
aliases: [
/topics/debugging,
/docs/reference/debugging,
/docs/reference/debugging.md
]
---

Valkey is developed with an emphasis on stability. We do our best with
Expand Down
6 changes: 0 additions & 6 deletions topics/distlock.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
---
title: "Distributed Locks with Valkey"
linkTitle: "Distributed locks"
weight: 1
description: >
A distributed lock pattern with Valkey
aliases: [
/topics/distlock,
/docs/reference/patterns/distributed-locks,
/docs/reference/patterns/distributed-locks.md
]
---
Distributed locks are a very useful primitive in many environments where
different processes must operate with shared resources in a mutually
Expand Down
6 changes: 0 additions & 6 deletions topics/encryption.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
---
title: "TLS"
linkTitle: "TLS"
weight: 1
description: Valkey TLS support
aliases: [
/topics/encryption,
/docs/manual/security/encryption,
/docs/manual/security/encryption.md
]
---

SSL/TLS is supported by Valkey as an optional feature
Expand Down
4 changes: 0 additions & 4 deletions topics/eval-intro.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
---
title: "Scripting with Lua"
linkTitle: "Lua scripting"
weight: 2
description: >
Executing Lua in Valkey
aliases:
- /topics/eval-intro
- /docs/manual/programmability/eval-intro/
---

Valkey lets users upload and execute Lua scripts on the server.
Expand Down
3 changes: 0 additions & 3 deletions topics/faq.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
---
title: "Valkey FAQ"
linkTitle: "FAQ"
weight: 100
description: >
Commonly asked questions when getting started with Valkey
aliases:
- /docs/getting-started/faq
---
## How is Valkey different from other key-value stores?

Expand Down
4 changes: 0 additions & 4 deletions topics/functions-intro.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
---
title: "Valkey functions"
linkTitle: "Functions"
weight: 1
description: >
Scripting with Redis OSS 7 and beyond
aliases:
- /topics/functions-intro
- /docs/manual/programmability/functions-intro/
---

Valkey Functions is an API for managing code to be executed on the server. This feature, which became available in Redis OSS 7, supersedes the use of [EVAL](eval-intro.md) in prior versions of Valkey.
Expand Down
1 change: 0 additions & 1 deletion topics/geospatial.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Valkey geospatial"
linkTitle: "Geospatial"
weight: 80
description: >
Introduction to the Valkey Geospatial data type
---
Expand Down
3 changes: 0 additions & 3 deletions topics/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@
title: "Quick starts"
linkTitle: "Quick starts"
hideListLinks: true
weight: 20
description: >
Valkey quick start guides
aliases:
- /docs/getting-started/
---

Valkey can be used as a database, cache, streaming engine, message broker, and more. The following quick start guides will show you how to use Valkey for the following specific purposes:
Expand Down
1 change: 0 additions & 1 deletion topics/hashes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Hashes"
linkTitle: "Hashes"
weight: 40
description: >
Introduction to Hashes
---
Expand Down
3 changes: 0 additions & 3 deletions topics/history.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Valkey history"
linkTitle: "History"
weight: 4
description: How the Valkey project started
aliases:
- /topics/history
---

Valkey is a fork of the open-source Redis (REmote DIctionary Server) database
Expand Down
3 changes: 0 additions & 3 deletions topics/hyperloglogs.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
---
title: "HyperLogLog"
linkTitle: "HyperLogLog"
weight: 1
description: >
HyperLogLog is a probabilistic data structure that estimates the cardinality of a set.
aliases:
- /docs/data-types/hyperloglogs/
---

HyperLogLog is a probabilistic data structure that estimates the cardinality of a set. As a probabilistic data structure, HyperLogLog trades perfect accuracy for efficient space utilization.
Expand Down
6 changes: 0 additions & 6 deletions topics/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
---
title: "Valkey Documentation"
linkTitle: "Documentation"
weight: 20
aliases:
- /documentation
- /documentation/
- /topics
- /topics/
---

The Valkey documentation is managed in markdown files in the
Expand Down
5 changes: 0 additions & 5 deletions topics/indexing.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
title: Secondary indexing
linkTitle: Secondary indexing
weight: 1
description: >
Building secondary indexes in Valkey
aliases: [
/topics/indexing,
/docs/reference/patterns/indexes
]
---

Valkey is not exactly a key-value store, since values can be complex data structures. However it has an external key-value shell: at API level data is addressed by the key name. It is fair to say that, natively, Valkey only offers *primary key access*. However since Valkey is a data structures server, its capabilities can be used for indexing, in order to create secondary indexes of different kinds, including composite (multi-column) indexes.
Expand Down
2 changes: 0 additions & 2 deletions topics/installation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: "Install Valkey"
linkTitle: "Install Valkey"
weight: 1
description: >
Install Valkey on Linux, macOS, and Windows
aliases:
- /docs/getting-started/installation
- /docs/getting-started/tutorial
---
Expand Down
4 changes: 0 additions & 4 deletions topics/internals-eventlib.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
---
title: "Event library"
linkTitle: "Event library"
weight: 1
description: What's an event library, and how was the original Valkey event library implemented?
aliases:
- /topics/internals-eventlib
- /topics/internals-rediseventlib
---

**Note: this document was written by the creator of Valkey, Salvatore Sanfilippo, early in the development of Valkey (c. 2010), and does not necessarily reflect the latest Valkey implementation.**
Expand Down
3 changes: 0 additions & 3 deletions topics/internals-sds.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "String internals"
linkTitle: "String internals"
weight: 1
description: Guide to the original implementation of Strings
aliases:
- /topics/internals-sds
---

**Note: this document was written by the creator of Valkey, Salvatore Sanfilippo, early in the development of Valkey (c. 2010). Virtual Memory has been deprecated since Redis OSS 2.6, so this documentation
Expand Down
4 changes: 0 additions & 4 deletions topics/internals-vm.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
---
title: "Virtual memory (deprecated)"
linkTitle: "Virtual memory"
weight: 1
description: A description of the Valkey virtual memory system that was deprecated in 2.6. This document exists for historical interest.
aliases:
- /topics/internals-vm
- /topics/virtual-memory
---

**Note: this document was written by the creator of Valkey, Salvatore Sanfilippo, early in the development of Valkey (c. 2010). Virtual Memory has been deprecated since Redis OSS 2.6, so this documentation
Expand Down
3 changes: 0 additions & 3 deletions topics/internals.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Valkey internals"
linkTitle: "Internals"
weight: 12
description: Documents describing internals in early Valkey implementations
aliases:
- /topics/internals
---

**The following Valkey documents were written by the creator of Valkey, Salvatore Sanfilippo, early in the development of Valkey (c. 2010), and do not necessarily reflect the latest Valkey implementation.**
4 changes: 0 additions & 4 deletions topics/introduction.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
---
title: Introduction to Valkey
linkTitle: "About"
weight: 10
description: Learn about the Valkey open source project
aliases:
- /topics/introduction
- /buzz
---

Valkey is an open source (BSD licensed), in-memory __data structure store__ used as a database, cache, message broker, and streaming engine. Valkey provides [data structures](data-types.md) such as
Expand Down
Loading

0 comments on commit b4afbed

Please sign in to comment.