Skip to content

BRANDING.md

Latest commit

 

History

History
141 lines (100 loc) · 5.07 KB

BRANDING.md

File metadata and controls

141 lines (100 loc) · 5.07 KB
Raw

English | 한국어 | 日本語 | 中文

Branding Guide — valkey-operator

Visual identity, voice, and tone for valkey-operator.

This document is the canonical reference for valkey-operator branding decisions. It applies to the README, release notes, marketing material, and any third-party communication that represents the project.

1. Identity

Organization: keiailab — Kubernetes-native data platform operators (MIT-licensed, license-clean, vanilla-upstream compatible).

Project: valkey-operator — MIT-licensed Valkey Operator for Kubernetes — Standalone + Cluster + Backup/Restore, BSD-3 license-clean.

2. Logo & Visual Assets

Asset URL Usage
Current primary logo docs/branding/symbol.png README header, slides
Keiailab base symbol docs/branding/base-symbol.png Source reference for the outer rotating-arrow mark
Current favicon https://keiailab.com/favicon.ico Favicon, social cards
Planned SVG kit https://keiailab.com/assets/{logo,mark,wordmark}.svg Future replacement after URLs return 200

Logo placement: Top-center of README, width 96px. Always link to https://keiailab.com.

Clear space: Minimum padding around logo = 25% of logo width.

Do not:

  • Recolor the logo
  • Add drop shadows or filters
  • Place on backgrounds with insufficient contrast
  • Combine with other logos without keiailab brand approval

3. Color Palette

Role Hex Usage
Primary (keiailab teal) #0EA5A8 Headers, primary actions, links
Secondary (deep navy) #0F172A Dark backgrounds, code blocks
Accent (warm amber) #F59E0B Highlights, badge accents
Neutral grey #64748B Body text on light backgrounds
Background light #F8FAFC Documentation page background
Background dark #020617 Code editor theme, dark mode

GitHub README 의 shield.io badge 는 위 hex 사용 권장.

4. Typography

  • Headings: System default (GitHub 의 default -apple-system, BlinkMacSystemFont, Segoe UI, ...)
  • Body: 동일 (GitHub-native 정합)
  • Code: ui-monospace, SFMono-Regular, Consolas, ... (GitHub 의 default monospace)

별도 webfont 사용 안 함 (GitHub README rendering 정합).

5. Voice & Tone

Audience: Kubernetes platform engineers / DBAs / SRE.

Voice principles:

  • Direct — bullet-point over paragraph where possible
  • Evidence-based — claims include benchmark / SLA / link
  • Vendor-neutral — reference upstream Valkey but do not embed/wrap third-party operators
  • License-aware — MIT/BSD/Apache-2.0/PG-license dependencies only

Avoid:

  • Marketing superlatives ("blazing fast", "revolutionary", "best-in-class")
  • Vague comparisons ("X-class quality") — qualify with specific metric or benchmark
  • Time-based deadlines in roadmap (use standards/roadmap.md §1.1 — feature checklist instead)

6. README Header Standard

모든 README 의 첫 문단은 다음 형식 (Wave 3 표준):

<p align="center">
  <img src="docs/branding/symbol.png" alt="keiailab" width="96"/>
</p>

# valkey-operator

> **MIT-licensed Valkey Operator for Kubernetes — Standalone + Cluster + Backup/Restore, BSD-3 license-clean**

<p align="center">
  <a href="LICENSE"><img src="https://img.shields.io/badge/<license placeholder>-blue.svg" alt="License"/></a>
  <!-- additional shield.io badges, in the §8 order -->
</p>

<p align="center">
  <b>English</b> |
  <a href="README.ko.md">한국어</a> |
  <a href="README.ja.md">日本語</a> |
  <a href="README.zh.md">中文</a>
</p>

7. README Footer Standard

모든 README + root-level .md 파일의 마지막에 다음 footer 부착 (Wave 3 표준):

---

<p align="center">© 2026 keiailab · <license placeholder> · <a href="https://keiailab.com">keiailab.com</a></p>

8. Badges 표준 순서

README 의 shield.io badge 순서 (좌→우):

  1. License (MIT)
  2. Go Version (1.25+)
  3. Database (Valkey 8.0+)
  4. Kubernetes Version (1.26+)
  5. Container Image (ghcr.io/keiailab)
  6. Helm Chart (Chart.yaml version + Artifact Hub link)
  7. OpenSSF Scorecard
  8. GitHub Discussions

9. Discussions / Issues / PR Templates

  • Discussions: https://github.com/keiailab/valkey-operator/discussions — feature ideas, Q&A
  • Issues: bug reports + concrete feature requests with use case
  • PR template: .github/PULL_REQUEST_TEMPLATE.md 표준 (사용자 시나리오 + 검증 명령 인용 의무, standards/checklist.md §3)

10. Social & External

11. License & Attribution

  • License: MIT
  • Copyright: © 2026 keiailab contributors
  • Third-party attributions: see NOTICE (if applicable)