Skip to content

Commit

Permalink
No valkey in titles (#193)
Browse files Browse the repository at this point in the history
* Deletes "Valkey" in titles, because "Valkey" or "Valkey documentation"
is added to each page title when the page is rendered.
* Deletes unused `linkTitle` frontmatter field.

---------

Signed-off-by: Viktor Söderqvist <[email protected]>
  • Loading branch information
zuiderkwast authored Nov 28, 2024
1 parent f1d0877 commit d6f2554
Show file tree
Hide file tree
Showing 68 changed files with 37 additions and 105 deletions.
1 change: 0 additions & 1 deletion topics/ARM.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "ARM support"
linkTitle: "ARM support"
description: >
Exploring Valkey on the ARM CPU Architecture
---
Expand Down
1 change: 0 additions & 1 deletion topics/RDMA.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "RDMA experimental support"
linkTitle: "RDMA support"
description: Valkey Over RDMA experimental support
---

Expand Down
1 change: 0 additions & 1 deletion topics/acl.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "ACL"
linkTitle: "ACL"
description: Valkey Access Control List
---

Expand Down
3 changes: 1 addition & 2 deletions topics/admin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Valkey administration
linkTitle: Administration
title: Administration
description: Advice for configuring and managing Valkey in production
---

Expand Down
3 changes: 1 addition & 2 deletions topics/benchmark.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey benchmark"
linkTitle: "Benchmarking"
title: "Benchmarking tool"
description: >
Using the valkey-benchmark utility on a Valkey server
---
Expand Down
1 change: 0 additions & 1 deletion topics/bitfields.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Bitfields"
linkTitle: "Bitfields"
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,6 +1,5 @@
---
title: "Bitmaps"
linkTitle: "Bitmaps"
description: >
Introduction to Bitmaps
---
Expand Down
3 changes: 1 addition & 2 deletions topics/cli.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey CLI"
linkTitle: "CLI"
title: "CLI"
description: >
Valkey command line interface
---
Expand Down
3 changes: 1 addition & 2 deletions topics/client-side-caching.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Client-side caching in Valkey"
linkTitle: "Client-side caching"
title: "Client-side caching"
description: >
Server-assisted, client-side caching in Valkey
---
Expand Down
3 changes: 1 addition & 2 deletions topics/clients.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey client handling"
linkTitle: "Client handling"
title: "Client handling"
description: >
How the Valkey server manages client connections
---
Expand Down
3 changes: 1 addition & 2 deletions topics/cluster-spec.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Valkey cluster specification
linkTitle: Cluster spec
title: Cluster specification
description: >
Detailed specification for Valkey cluster
---
Expand Down
3 changes: 1 addition & 2 deletions topics/cluster-tutorial.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Scale with Valkey Cluster
linkTitle: Scale with Valkey Cluster
title: Cluster tutorial
description: Horizontal scaling with Valkey Cluster
---

Expand Down
3 changes: 1 addition & 2 deletions topics/command-arguments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey command arguments"
linkTitle: "Command arguments"
title: "Command arguments"
description: How Valkey commands expose their documentation programmatically
---

Expand Down
3 changes: 1 addition & 2 deletions topics/command-tips.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey command tips"
linkTitle: "Command tips"
title: "Command tips"
description: Get additional information about a command
---

Expand Down
3 changes: 1 addition & 2 deletions topics/data-types.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey data types"
linkTitle: "Data types"
title: "Data types"
description: Overview of data types supported by Valkey
---

Expand Down
1 change: 0 additions & 1 deletion topics/debugging.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Debugging"
linkTitle: "Debugging"
description: >
A guide to debugging Valkey server processes
---
Expand Down
3 changes: 1 addition & 2 deletions topics/distlock.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Distributed Locks with Valkey"
linkTitle: "Distributed locks"
title: "Distributed Locks"
description: >
A distributed lock pattern with Valkey
---
Expand Down
1 change: 0 additions & 1 deletion topics/encryption.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "TLS"
linkTitle: "TLS"
description: Valkey TLS support
---

Expand Down
1 change: 0 additions & 1 deletion topics/eval-intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Scripting with Lua"
linkTitle: "Lua scripting"
description: >
Executing Lua in Valkey
---
Expand Down
3 changes: 1 addition & 2 deletions topics/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey FAQ"
linkTitle: "FAQ"
title: "FAQ"
description: >
Commonly asked questions when getting started with Valkey
---
Expand Down
3 changes: 1 addition & 2 deletions topics/functions-intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey functions"
linkTitle: "Functions"
title: "Functions"
description: >
Scripting with Redis OSS 7 and beyond
---
Expand Down
3 changes: 1 addition & 2 deletions topics/geospatial.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey geospatial"
linkTitle: "Geospatial"
title: "Geospatial"
description: >
Introduction to the Valkey Geospatial data type
---
Expand Down
1 change: 0 additions & 1 deletion topics/get-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Quick starts"
linkTitle: "Quick starts"
hideListLinks: true
description: >
Valkey quick start guides
Expand Down
1 change: 0 additions & 1 deletion topics/hashes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Hashes"
linkTitle: "Hashes"
description: >
Introduction to Hashes
---
Expand Down
3 changes: 1 addition & 2 deletions topics/history.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey history"
linkTitle: "History"
title: "History"
description: How the Valkey project started
---

Expand Down
1 change: 0 additions & 1 deletion topics/hyperloglogs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "HyperLogLog"
linkTitle: "HyperLogLog"
description: >
HyperLogLog is a probabilistic data structure that estimates the cardinality of a set.
---
Expand Down
1 change: 0 additions & 1 deletion topics/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey Documentation"
linkTitle: "Documentation"
---

The Valkey documentation is managed in markdown files in the
Expand Down
1 change: 0 additions & 1 deletion topics/indexing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Secondary indexing
linkTitle: Secondary indexing
description: >
Building secondary indexes in Valkey
---
Expand Down
3 changes: 1 addition & 2 deletions topics/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Install Valkey"
linkTitle: "Install Valkey"
title: "Installation"
description: >
Install Valkey on Linux, macOS, and Windows
---
Expand Down
3 changes: 1 addition & 2 deletions topics/introduction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Introduction to Valkey
linkTitle: "About"
title: Introduction
description: Learn about the Valkey open source project
---

Expand Down
1 change: 0 additions & 1 deletion topics/keyspace.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Keyspace"
linkTitle: "Keyspace"
description: >
Managing keys in Valkey: Key expiration, scanning, altering and querying the key space
---
Expand Down
3 changes: 1 addition & 2 deletions topics/latency-monitor.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey latency monitoring"
linkTitle: "Latency monitoring"
title: "Latency monitoring"
description: Discovering slow server events in Valkey
---

Expand Down
1 change: 0 additions & 1 deletion topics/latency.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Diagnosing latency issues"
linkTitle: "Latency diagnosis"
description: Finding the causes of slow responses
---

Expand Down
3 changes: 1 addition & 2 deletions topics/ldb.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Debugging Lua scripts in Valkey
linkTitle: Debugging Lua
title: Debugging Lua scripts
description: How to use the built-in Lua debugger
---

Expand Down
3 changes: 1 addition & 2 deletions topics/license.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey license"
linkTitle: "License"
title: "License"
description: >
License and trademark information
---
Expand Down
1 change: 0 additions & 1 deletion topics/lists.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Lists"
linkTitle: "Lists"
description: >
Introduction to Lists
---
Expand Down
1 change: 0 additions & 1 deletion topics/lru-cache.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Key eviction
linkTitle: Eviction
description: Overview of Valkey key eviction policies (LRU, LFU, etc.)
---

Expand Down
3 changes: 1 addition & 2 deletions topics/lua-api.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey Lua API reference"
linkTitle: "Lua API"
title: "Lua API reference"
description: >
Executing Lua in Valkey
---
Expand Down
1 change: 0 additions & 1 deletion topics/mass-insertion.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Bulk loading"
linkTitle: "Bulk loading"
description: >
Writing data in bulk using the RESP protocol
---
Expand Down
1 change: 0 additions & 1 deletion topics/memory-optimization.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Memory optimization
linkTitle: Memory optimization
description: Strategies for optimizing memory usage in Valkey
---

Expand Down
1 change: 0 additions & 1 deletion topics/migration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Migration from Redis to Valkey
linkTitle: Migration
description: How to migrate from Redis to Valkey
---

Expand Down
1 change: 0 additions & 1 deletion topics/modules-api-ref.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Modules API reference"
linkTitle: "API reference"
description: >
Reference for the Valkey Modules API
---
Expand Down
3 changes: 1 addition & 2 deletions topics/modules-blocking-ops.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey modules and blocking commands"
linkTitle: "Blocking commands"
title: "Modules and blocking commands"
description: >
How to implement blocking commands in a Valkey module
---
Expand Down
3 changes: 1 addition & 2 deletions topics/modules-intro.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey modules API"
linkTitle: "Modules API"
title: "Modules API"
description: >
Introduction to writing Valkey modules
---
Expand Down
1 change: 0 additions & 1 deletion topics/modules-native-types.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Modules API for native types"
linkTitle: "Native types API"
description: >
How to use native types in a Valkey module
---
Expand Down
3 changes: 1 addition & 2 deletions topics/notifications.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey keyspace notifications"
linkTitle: "Keyspace notifications"
title: "Keyspace notifications"
description: >
Monitor changes to Valkey keys and values in real time
---
Expand Down
3 changes: 1 addition & 2 deletions topics/performance-on-cpu.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey CPU profiling"
linkTitle: "CPU profiling"
title: "CPU profiling"
description: >
Performance engineering guide for on-CPU profiling and tracing
---
Expand Down
3 changes: 1 addition & 2 deletions topics/persistence.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Valkey persistence
linkTitle: Persistence
title: Persistence
description: How Valkey writes data to disk
---

Expand Down
3 changes: 1 addition & 2 deletions topics/pipelining.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey pipelining"
linkTitle: "Pipelining"
title: "Pipelining"
description: How to optimize round-trip times by batching Valkey commands
---

Expand Down
1 change: 0 additions & 1 deletion topics/problems.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Troubleshooting Valkey"
linkTitle: "Troubleshooting"
description: Problems with Valkey? Start here.
---

Expand Down
3 changes: 1 addition & 2 deletions topics/programmability.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Valkey programmability"
linkTitle: "Programmability"
title: "Programmability"
description: >
Extending Valkey with Lua and Valkey Functions
---
Expand Down
1 change: 0 additions & 1 deletion topics/protocol.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Serialization protocol specification"
linkTitle: "Protocol spec"
description: Valkey's serialization protocol (RESP) is the wire protocol that clients implement
----

Expand Down
3 changes: 1 addition & 2 deletions topics/pubsub.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Valkey Pub/Sub
linkTitle: "Pub/sub"
title: Pub/Sub
description: How to use pub/sub channels in Valkey
---

Expand Down
Loading

0 comments on commit d6f2554

Please sign in to comment.