Skip to content

Commit

Permalink
chore: adds meta descriptions to improve indexing/SEO/etc (#959)
Browse files Browse the repository at this point in the history
I was looking into what we could do to improve our indexing and social
object graph. I don't think there's much except adding
meta-descriptions. These aren't as important as they used to be, but
they can still improve indexing and increase likelihood of sharing on
social media, etc.

Adding a markdown metadata section with `description` in mkdocs results
in it being used in the description meta tag for the page, so I've done
that for some pages that are likely to be searched.

Signed-off-by: Todd Baert <[email protected]>
  • Loading branch information
toddbaert authored Oct 10, 2023
1 parent be61450 commit f3506ab
Show file tree
Hide file tree
Showing 14 changed files with 56 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: flagd architecture
---

# Architecture

flagd architectures fall into two broad categories: those where the evaluation engine is deployed in a standalone process to which the client application connects ([RPC](#rpc-evaluation)), and those where the evaluation engine is embedded into the client application ([in-process](#in-process-evaluation)).
Expand Down
4 changes: 4 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: flagd faq
---

# Frequently Asked Questions

> Why do I need this? Can't I just use environment variables?
Expand Down
4 changes: 4 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: installing flagd
---

# Installation

## Docker
Expand Down
4 changes: 4 additions & 0 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: flagd quick start
---

# Quick Start

Learn the basics of flagd from the comfort of your terminal.
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/custom-operations/fractional-operation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: flagd fractional custom operation
---

# Fractional Operation

OpenFeature allows clients to pass contextual information which can then be used during a flag evaluation. For example, a client could pass the email address of the user.
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/custom-operations/semver-operation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: flagd semver custom operation
---

# Semantic Version Operation

OpenFeature allows clients to pass contextual information which can then be used during a flag evaluation. For example, a client could pass the email address of the user.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: flagd string custom operations
---

# Starts-With / Ends-With Operation

OpenFeature allows clients to pass contextual information which can then be used during a flag evaluation. For example, a client could pass the email address of the user.
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/flag-definitions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: flagd flag definition
---

# Flag Definitions

## Flags
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/monitoring.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: monitoring and telemetry flagd and flagd providers
---

# Monitoring

## Readiness & Liveness probes
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/naming.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: naming conventions for flagd and associated artifacts
---

# Naming

_flagd_ was conceived as a simple program with a POSIX-style CLI that's designed to run as a service or [daemon](https://en.wikipedia.org/wiki/Daemon_(computing)).
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/specifications/in-process-providers.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: flagd in-process proivider specification
---

# Creating an in-process flagd provider

An in-process flagd provider is designed to be embedded into the application, and therefore no communication outside the process of the application for feature flag evaluation is needed.
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/specifications/rpc-providers.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: flagd RPC proivider specification
---

# Creating an RPC flagd provider

By default, **flagd** is a remote service that is accessed via **grpc** by a client application to retrieve feature flags.
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/sync-configuration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: sync configuration overview for flagd and flagd providers
---

# Sync configuration

See [syncs](../concepts/syncs.md) for a conceptual overview.
Expand Down
4 changes: 4 additions & 0 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: troubleshooting flagd
---

# Troubleshooting flagd

## Debugging Evaluations
Expand Down

0 comments on commit f3506ab

Please sign in to comment.