Skip to content

Commit

Permalink
refactor: improve seo for elasticsearch
Browse files Browse the repository at this point in the history
Signed-off-by: seven <[email protected]>
  • Loading branch information
Blankll committed Aug 15, 2024
1 parent 1e9a660 commit 2d1f666
Show file tree
Hide file tree
Showing 11 changed files with 110 additions and 97 deletions.
11 changes: 6 additions & 5 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
import {defineConfig} from 'vitepress'

const title = "DocKit - GUI Client for Elasticsearch/OpenSearch";
const description = "DocKit is an open-source Elasticsearch gui client, OpenSearch gui client for Mac, windows and Linux, 开源 Elasticsearch OpenSearch 桌面客户端";
const title = "DocKit - Elasticsearch Desktop Client";
const description = "DocKit is an open-source Elasticsearch gui client, OpenSearch gui client for Mac, windows and Linux";
const href = "/favicon.ico";
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: 'DocKit',
title,
description,
outDir: '../dist',
cacheDir: '../cache',
head: [
['link', {rel: 'icon', href}],
['meta', {name: 'description', content: description}],
['meta', {name: 'keywords', content: 'elasticsearch, gui, client, opensearch, dockit, mac, windows, linux'}],
['meta', {name: 'keywords', content: 'elasticsearch, gui, client, opensearch, dockit, database, NoSQL, Kibana, mac, windows, linux'}],
['meta', {property: 'og:title', content: title}],
['meta', {property: 'og:description', content: description}],
['meta', {property: 'og:image', content: href}],
Expand All @@ -32,6 +32,7 @@ export default defineConfig({
nav: [
{text: 'Home', link: '/'},
{text: 'Docs', link: '/docs'},
{text: 'Blog', link: '/blog'},
{text: 'Download', link: '/download'}
],

Expand All @@ -58,7 +59,7 @@ export default defineConfig({
{icon: 'twitter', link: 'https://x.com/Blankll31075'},
],
footer: {
message: 'Dockit is an open-source desktop GUI client for Elasticsearch and OpenSearch across Mac, windows and Linux',
message: 'Dockit is an open-source desktop GUI client for Elasticsearch and OpenSearch across Mac, windows and Linux',
copyright: 'Copyright © 2023-present <a href="https://github.com/geek-fun">geek-fun</a>'
}
},
Expand Down
7 changes: 7 additions & 0 deletions docs/blog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Blog
Welcome to explore DocKit! :rocket::rocket::rocket: the blog section will provide you usefully skills and tips to use DocKit and some knowledge share about [Elasticsearch](https://www.elastic.co/), [OpenSearch](https://opensearch.org/), and more to come.


## [Introduction to Elasticsearch Desktop Client - DocKit](/blog/elasticsearch-desktop-client.md)
Are you searching for the best Elasticsearch desktop client to streamline your development data management? Look no further! In this comprehensive guide, we will introduce you to DocKit, a top-tier Elasticsearch desktop client designed to enhance your workflow and boost productivity. Whether you're a seasoned developer or just starting out, finding the right tool can make all the difference.

35 changes: 35 additions & 0 deletions docs/blog/elasticsearch-desktop-client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Introduction to Elasticsearch Desktop Client - DocKit

Are you searching for the best Elasticsearch desktop client to streamline your development data management? Look no further! In this comprehensive guide, we will introduce you to DocKit, a top-tier Elasticsearch desktop client designed to enhance your workflow and boost productivity. Whether you're a seasoned developer or just starting out, finding the right tool can make all the difference.

## Why Choose an Elasticsearch Desktop Client?

[Elasticsearch](https://www.elastic.co/elasticsearch) is a powerful search and analytics engine, but managing it effectively requires the right tools. An Elasticsearch desktop client provides a user-friendly interface, advanced search capabilities, and efficient data management features. With DocKit, you can unlock the full potential of Elasticsearch and optimize your data management experience.

DocKit is a desktop client, compared to the web-based [Kibana](https://www.elastic.co/kibana), it provides a more handy and efficient way to manage your Elasticsearch server, from your local you don't need to run kibana inside a container to occupy massive disk and memory, and meanwhile, DocKit can connect to multiple Elasticsearch servers at the same time so you can switch between your application environments instantly, which is more flexible than Kibana.

DocKit also support [OpenSearch](https://opensearch.org/), which provide seamless features and user experience for OpenSearch users, so developer don't need to switch between Kibana and [OpenSearch Dashboards](https://opensearch.org/docs/latest/dashboards/), they can use DocKit to manage both Elasticsearch and OpenSearch clusters.

![DocKit UI](/public/client-ui.png)
## Key Features of DocKit

DocKit offers a range of features to suit your specific needs:
- **User-Friendly Interface**: Navigate through your Elasticsearch/OpenSearch server with ease using DocKit's intuitive interface.
- **Advanced Search Capabilities**: Perform complex searches and analyze your data efficiently.
- **Cross-Platform Support**: Available for Mac, Windows, and Linux, ensuring compatibility with your operating system.
- **Open-Source**: DocKit is an open-source project, allowing for community contributions and continuous improvement.
- **Multiple Server Support**: Connect to multiple Elasticsearch/OpenSearch servers simultaneously, streamlining your workflow.
- **AI-Powered Search**: Utilize AI-powered search capabilities to enhance your data analysis and visualization.

## How to Get Started with DocKit

Getting started with DocKit is simple:
1. **Download and Install**: Visit the [official DocKit website](https://dockit.geekfun.club) to download the latest version for your operating system. follow the [installation guide](/docs/installation.md) to install DocKit.
2. **Connect to Your Elasticsearch Server**: Follow the [installation guide](/docs/connect-to-server.md) to connect DocKit to your Elasticsearch server.
3. **Explore and Manage Your Data**: Use DocKit's powerful features to manage and analyze your Elasticsearch data.

## Conclusion

Choosing the right Elasticsearch desktop client is crucial for efficient data management and analysis. DocKit stands out as a top choice, offering a user-friendly interface, advanced search capabilities, and cross-platform support. Don't waste time with subpar tools—optimize your workflow with DocKit and unlock the full potential of Elasticsearch.

For more information and to download DocKit, visit the [official website](https://dockit.geekfun.club).
2 changes: 1 addition & 1 deletion docs/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ DocKit as a NoSQL/NewSQL GUI client Elasticsearch, OpenSearch, and more to come.
Thanks for trying out DocKit! :rocket::rocket::rocket: This guide will help you get started with DocKit.

## [Connect to Server](/docs/connect-to-server.md)
DocKit as a NoSQL GUI client, it supports multiple databases, including Elasticsearch, OpenSearch, and more to come. This document outlines how to connect to a database server using DocKit.
DocKit as a NoSQL GUI client, it supports multiple databases, including Elasticsearch, OpenSearch, and more to come. This document outlines how to connect to a ElasticSearch server using DocKit.

## [Shortcuts Introduction](/docs/shortcut.md)
As a Desktop Application, DocKit provides a set of shortcuts to help users use DocKit more efficiently. This document outlines the available shortcuts and corresponding actions.
Expand Down
16 changes: 8 additions & 8 deletions docs/docs/connect-to-server.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# DocKit connect to server
DocKit as a NoSQL GUI client, it supports multiple databases, including Elasticsearch, OpenSearch, and more to come. This document outlines how to connect to a database server using DocKit.
# DocKit connect to Elasticsearch server
DocKit as a NoSQL GUI client, it supports multiple databases, including [Elasticsearch](https://www.elastic.co), OpenSearch, and more to come. This document outlines how to connect to a database server using DocKit.
## Install and Open DocKit
you can find detailed instructions on how to install and open DocKit in the [installation guide](../docs/installation.md).

## Connect to Server
After opening DocKit, click the `+ New connection` button to add a new connection, then you can input the connection information, including the connection name, host, port, and authentication information.
![mac connect to server](/mac-connect-to-server.png)
## Connect to Elasticsearch Server
After opening DocKit, click the `+ New connection` button to add a new connection, then you can input the Elasticsearch server information, including the connection name, host, port, and authentication information.
![mac connect to Elasticsearch server](/mac-connect-to-server.png)

Notice:
1. the host requires a comprehensive domain include protocol `http` or `https`
2. if you try to connect to a self-signed server, you can disable the certificate validation by unblock the :lock:
2. if you try to connect to a self-signed Elasticsearch server, you can disable the certificate validation by unblock the :lock:

## Test connection
once all your input finish, simply click the `Test Connection` button to verify if DocKit can connect to the configured server
once all your input finish, simply click the `Test Connection` button to verify if DocKit can connect to the configured Elasticsearch server

## Save Connection

Simply Click `Confirm` to save Connections so you can always access target server with DocKit
Simply Click `Confirm` to save Connections so you can always access target Elasticsearch server with DocKit.
2 changes: 1 addition & 1 deletion docs/docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DocKit Installation
Thanks for trying out DocKit!:rocket::rocket::rocket: This guide will help you get started with DocKit.

Before use DocKit to connect to your Elasticsearch server, you need to install it first.
## Download DocKit
you can download the latest version of DocKit from the [Download](../download.md) page, then select the target platform to download the corresponding installation package.
DocKit recently supports Windows, macOS, and Linux.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/shortcut.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DocKit Shortcuts Introduction
As a Desktop Application, DocKit provides a set of shortcuts to help users use DocKit more efficiently. This document outlines the available shortcuts and corresponding actions.

These shortcuts are designed to streamline your workflow and enhance your productivity when working with DocKit to manage your Elasticsearch/OpenSearch server.
## Shortcuts
| Feature | Shortcut | Description | State |
|-----------------|-------------------------|--------------------------------------------------------------------------|--------------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ outline: deep

# Download DocKit
Thanks for trying out DocKit! :rocket::rocket::rocket: DocKit is a new NoSQL GUI client with supper lightweight and support across Windows, macOS, and Linux.

DocKit support Elasticsearch, OpenSearch, and more to come([DynamoDB](https://aws.amazon.com/dynamodb/), [MongoDB](https://www.mongodb.com/), etc), you can download the latest version of DocKit from the following links.
## Download DocKit Binary
<Download></Download>
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ layout: home
hero:
name: "DocKit"
text: A better NoSQL/NewSQL GUI client
tagline: Explore your data any time from your laptop
tagline: Manage your ElasticSearch/OpenSearch servers with ease, support platforms across Windows, macOS, and Linux
image:
src: dockit.png
alt: DocKit logo
Expand All @@ -21,9 +21,9 @@ features:
- title: Full featured editor
details: Powered by monaco-editor the backbones of vscode, provide familiar editor environment for developers
- title: Keep your connections
details: Keep your connections in desktop apps, move the dependencies of dashboard tools
details: Keep your Elasticsearch server connections in DocKit move the dependencies of dashboard tools
- title: File persistence
details: Save your code in your machine as file, never lost
details: Save your ElasticSearch Query in your machine as file, never lost
- title: Multi engines support
details: Support Elasticsearch, OpenSearch, and more to come
---
Expand Down
Loading

0 comments on commit 2d1f666

Please sign in to comment.