Crystal Pham
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.

      Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

      Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

      Explore these features while you wait
      Complete general settings
      Bookmark and like published notes
      Write a few more notes
      Complete general settings
      Write a few more notes
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights New
    • Make a copy
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Make a copy Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.

    Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Explore these features while you wait
    Complete general settings
    Bookmark and like published notes
    Write a few more notes
    Complete general settings
    Write a few more notes
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    --- title: 'Valkey Community Wiki' --- <div style=" position:fixed; top: 50px; right: 20px; width: 50px; border-left: 3px solid #007bff; padding-left: 15px; background: #ffffff; box-shadow: -2px 2px 10px rgba(0,0,0,0.05); z-index: 100; "> <b>Navigation</b> [TOC] </div> <style> .markdown-body { max-width: 900px !important; margin: 0 auto; } .guide-card { border: 1px solid #e1e4e8; border-radius: 6px; padding: 1.5em; margin-bottom: 2em; background-color: #f6f8fa; } .step-number { background: #232d37; color: white; border-radius: 50%; width: 24px; height: 24px; display: inline-block; text-align: center; line-height: 24px; margin-right: 10px; font-size: 14px; } </style> <img src="https://hackmd.io/_uploads/S1h_aLl5Ze.svg" width=50%> # Valkey Community Wiki Welcome to the **Valkey Project** community wiki. Valkey is an open-source, high-performance key-value store hosted by [The Linux Foundation](https://www.linuxfoundation.org/press/linux-foundation-launches-open-source-valkey-community). ### Quick Links - [Technical Steering Committee (TSC)](https://github.com/valkey-io/valkey/blob/unstable/GOVERNANCE.md) - [Community Code of Conduct](https://valkey.io/code_of_conduct/) - [Main Website](https://valkey.io) --- ## 🚀 Ways to Get Involved ### 1. Contributing to the Valkey Blog We welcome both **Community** and **Project** focused content. Regardless of the type, all blog journeys begin on GitHub. :::info 💡 **Crucial First Step**: Before writing, always [Open a GitHub Issue](https://github.com/valkey-io/valkey-io.github.io/issues/new?template=blog_post_template.md) to pitch your idea. This ensures your topic is aligned with the roadmap and prevents duplicate efforts. ::: #### 📝 Community Blogs *Focus: Tutorials, use-cases, event recaps, and integrations.* :::spoiler View Community Submission Process 1. **Pitch it:** Open a [GitHub Issue](https://github.com/valkey-io/valkey-io.github.io/issues) with your topic summary. 2. **Choose your drafting method (pick what works for you):** - 🧑‍💻 **GitHub PR (for contributors comfortable with Git):** You can fork the repo and submit a pull request directly with your blog draft. Make sure to add PR to the issue. - 📝 **Google Docs / Word (recommended if you prefer writing first):** Draft your content in Google Docs or Word and share the link in the [submission form](https://form.asana.com/?k=9zh9lhK3yWLavaOi6C0hgA&d=9283783873717). 3. **Review:** The team will review your submission and provide feedback or next steps. ::: #### 🛠️ Project Blogs *Focus: Official releases, deep technical milestones, and governance updates.* :::spoiler View Technical/Project Submission Process (Zola) 1. **Issue First:** Open a [blog issue on GitHub](https://github.com/valkey-io/valkey-io.github.io/issues/new?template=blog_post_template.md). 2. **Fork & Branch:** Fork the [valkey-io.github.io](https://github.com/valkey-io/valkey-io.github.io) repo. 3. **Author Profile:** Add your headshot to `static/assets/media/authors` and create `authors/yourname.md`. 4. **Create Content:** * Create folder: `content/blog/yyyy-mm-dd-title' * Add file: `index.md` * Test locally using `zola serve`. 5. **Submit PR:** Link your PR to the original GitHub issue. ::: :::warning ### ⚠️ Contribution Checklist for ALL blogs 1. **Issue First:** Always create an issue prior to drafting. 2. **DCO Sign-off:** We require Developer Certificate of Origin sign-offs. Use the `-s` flag in your commits: `git commit -s -m "Your commit message"` 3. **Stay Vendor Neutral:** All contributions must benefit the community as a whole. --- ::: ### 2. Run a Local Meetup Help grow the Valkey ecosystem by hosting or organizing a local gathering. [Detailed Meetup Charter](https://valkey.io/community/meetup-groups/). :::info **Planning a Meetup?** [Fill out this form](https://form.asana.com/?k=9zh9lhK3yWLavaOi6C0hgA&d=9283783873717) to get social media support and promotion from the official Valkey channels. ::: :::spoiler Meetup Guidelines & Best Practices #### Goals * **Educate:** Share real-world Valkey production stories. * **Connect:** Bridge the gap between maintainers and local users. * **Grow:** Increase awareness of high-performance open-source infra. #### Post-Meetup Checklist * **Share Highlights:** Use `#ValkeyCommunity` on social media. * **Recap:** Post slides or a short summary to the GitHub discussion board. * **Feedback:** Ask your local community what they want to see next! ::: --- ### 3. Community Calendar & Meetings **➡️ [View Valkey Events](https://valkey.io/events/)** ### 4. Contribution Directory by Feature Valkey is a multi-repository project. Use the guide below to find "Good First Issues" based on your technical interests. | Feature Area | Tech Stack | Repository | Best For... | | :--- | :--- | :--- | :--- | | **Valkey Core** | C | [`valkey-io/valkey`](https://github.com/valkey-io/valkey) | Database internals, performance, & CLI. | | **Search & AI** | C++ | [`valkey-io/valkey-search`](https://github.com/valkey-io/valkey-search) | Vector search, indexing, & query engines. | | **Admin Tools** | TypeScript/React | [`valkey-io/valkey-admin`](https://github.com/valkey-io/valkey-admin) | UI/UX, dashboards, & cluster management. | | **Glide (Clients)** | Rust / Polyglot | [`valkey-io/valkey-glide`](https://github.com/valkey-io/valkey-glide) | Cross-language drivers (Java, Python, Go). | | **Documentation** | Markdown | [`valkey-io/valkey-doc`](https://github.com/valkey-io/valkey-doc) | Technical writing & examples. | --- ### 🔍 Where to find "Good First Issues" #### 1. Valkey Search (Indexing & Vector Search) Perfect for those who enjoy C++ and data structures. * **Focus:** Improving query parser error messages and adding unit tests for edge-case filters. * [👉 View Search Issues](https://github.com/valkey-io/valkey-search/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) #### 2. Valkey Admin (Management Console) The best place for Frontend and Fullstack developers. * **Focus:** Visualizing cluster topology, improving the "Hot Key" dashboard, and UI polishing. * [👉 View Admin Issues](https://github.com/valkey-io/valkey-admin/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) #### 3. Valkey Core (The Engine) If you know C, this is where the magic happens. * **Focus:** Adding new metrics to `INFO` commands and refactoring legacy code for better readability. * [👉 View Core Issues](https://github.com/valkey-io/valkey/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) #### 4. Valkey Glide (Reliable Clients) Help build the bridge between Valkey and the world's most popular languages. * **Focus:** Implementing missing commands in specific language wrappers (e.g., Python or Java). * [👉 View Glide Issues](https://github.com/valkey-io/valkey-glide/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) :::warning ### ⚠️ Contribution Checklist 1. **Comment First:** Always comment on an issue saying *"I would like to work on this"* before starting. 2. **DCO Sign-off:** We require Developer Certificate of Origin sign-offs. Use the `-s` flag in your commits: `git commit -s -m "Your commit message"` 3. **Stay Vendor Neutral:** All contributions must benefit the community as a whole. ### ⚖️ Project Leadership & Governance ::::info **Learn about the roles and responsibilities** :::spoiler Leadership & Governance Details ### Meet the Leadership Valkey is a community-led project under **The Linux Foundation**. Our governance is designed to be transparent, meritocratic, and vendor-neutral. 👉 **[Official Leadership Directory](https://valkey.io/leadership/)** --- #### 🏗️ Governance Bodies * **Technical Steering Committee (TSC):** Responsible for technical direction, release cycles, and architectural evolution. Members are elected based on merit. * **Maintainers:** The "boots on the ground" who review code and manage specific repositories (Core, Search, Glide, etc.). #### 📈 The Contributor Ladder | Role | Responsibility | How to Reach | | :--- | :--- | :--- | | **Contributor** | Submits code or docs. | Open your first Pull Request. | | **Member** | Regular contributor. | Sponsorship by a Maintainer. | | **Maintainer** | Approves/Merges PRs. | High-impact, consistent leadership. | | **TSC Member** | Sets project policy. | Elected by the maintainers. |

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password
    or
    Sign in via Google Sign in via Facebook Sign in via X(Twitter) Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    By signing in, you agree to our terms of service.

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully