From 84fc5c18065447cf21a7d810c83e49e933722d18 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 29 May 2025 07:55:50 -0500 Subject: [PATCH] fix(explorer): Add Explorer to products.yml, move to version folder, add get-started step nav, cleanup --- content/explorer/_index.md | 45 ------------------- content/explorer/getting_started/_index.md | 12 ----- .../getting_started/connect-to-a-server.md | 12 ----- content/explorer/v1/_index.md | 38 ++++++++++++++++ .../{about_the_project => v1/about}/_index.md | 3 +- content/explorer/v1/get-started/_index.md | 13 ++++++ content/explorer/v1/get-started/connect.md | 11 +++++ data/products.yml | 14 ++++++ 8 files changed, 78 insertions(+), 70 deletions(-) delete mode 100644 content/explorer/_index.md delete mode 100644 content/explorer/getting_started/_index.md delete mode 100644 content/explorer/getting_started/connect-to-a-server.md create mode 100644 content/explorer/v1/_index.md rename content/explorer/{about_the_project => v1/about}/_index.md (94%) create mode 100644 content/explorer/v1/get-started/_index.md create mode 100644 content/explorer/v1/get-started/connect.md diff --git a/content/explorer/_index.md b/content/explorer/_index.md deleted file mode 100644 index 1555b376f..000000000 --- a/content/explorer/_index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: InfluxDB 3 Explorer Documentation -description: > - InfluxDB 3 Explorer is a web-based interface for interacting with InfluxDB 3 Core and Enterprise. Visualize, query, and manage your time series data efficiently. -menu: - explorer_v1: - name: InfluxDB 3 Explorer -weight: 1 -aliases: - - /explorer/ - - /explorer/v3/ - - /influxdb/v3/explorer/ ---- - -InfluxDB 3 Explorer is a web application designed for visualizing, querying, and managing your InfluxDB 3 Core and Enterprise data. It provides an intuitive interface to easily interact with your time series data, simplifying operations and enhancing data insights. - -## Overview - -InfluxDB 3 Explorer enables users to explore and visualize data with a built-in visualizer, quickly write new data, and manage their databases and token setups. - -## Key Features - -### Database and Query Management - -- Create and manage InfluxDB 3 databases -- Create and manage admin and resource tokens -- Configure new instance of InfluxDB 3 Enterprise - -### Data Management - -- Quickly query data with a built-in visualizer -- Write new data and setup new Telegraf configurations. - -## Deployment with Docker - -### Quick Start - -Run InfluxDB 3 Explorer quickly with Docker: - -```sh -docker run -d \ - -p 8888:80 \ - -p 8889:8888 \ - explorer:latest \ - --MODE=admin diff --git a/content/explorer/getting_started/_index.md b/content/explorer/getting_started/_index.md deleted file mode 100644 index cb102f250..000000000 --- a/content/explorer/getting_started/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Getting Started Guides for Explorer -description: Step-by-step instructions for using Explorer's features. -menu: - explorer_v1: - name: Getting Started - weight: 30 ---- - -Follow the links below to get started using InfluxDB 3 Explorer. - -{{< children >}} diff --git a/content/explorer/getting_started/connect-to-a-server.md b/content/explorer/getting_started/connect-to-a-server.md deleted file mode 100644 index d8b77cce0..000000000 --- a/content/explorer/getting_started/connect-to-a-server.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Connect to a server -description: - Connecting to a server in InfluxDB 3 Explorer -menu: - explorer_v1: - name: Connect to a server - parent: Getting Started -weight: 10 ---- - -This guide explains how to connect to a server in InfluxDB 3 Explorer, the first step to getting started with Explorer. \ No newline at end of file diff --git a/content/explorer/v1/_index.md b/content/explorer/v1/_index.md new file mode 100644 index 000000000..9f4f7c571 --- /dev/null +++ b/content/explorer/v1/_index.md @@ -0,0 +1,38 @@ +--- +title: InfluxDB 3 Explorer documentation +description: > + InfluxDB 3 Explorer is a standalone web-based interface for interacting with InfluxDB 3 Core and Enterprise. Visualize, query, and manage your time series data efficiently. +menu: + explorer_v1: + name: InfluxDB 3 Explorer +weight: 1 +aliases: + - /explorer/ + - /explorer/v3/ + - /influxdb/v3/explorer/ +--- + +InfluxDB 3 Explorer is the standalone web application designed for visualizing, querying, and managing your data stored in InfluxDB 3 Core and Enterprise. +Explorer provides an intuitive interface for interacting with your time series data, streamlining database operations and enhancing data insights. + +## Key features + +Use InfluxDB 3 Explorer for: + +- **Database and query management**: Create and manage InfluxDB 3 databases, admin and resource tokens, and configure new InfluxDB 3 Enterprise instances +- **Data visualization and analysis**: Query data with a built-in visualizer for enhanced data insights +- **Data ingestion**: Write new data and setup Telegraf configurations + +## Quick start + +Run the Docker image to start InfluxDB 3 Explorer: + +```sh +docker run -d \ + -p 8888:80 \ + -p 8889:8888 \ + explorer:latest \ + --MODE=admin +``` + +[Get started with InfluxDB 3 Explorer](/explorer/v1/get-started/) diff --git a/content/explorer/about_the_project/_index.md b/content/explorer/v1/about/_index.md similarity index 94% rename from content/explorer/about_the_project/_index.md rename to content/explorer/v1/about/_index.md index 62fdeeedb..fc2b6eb06 100644 --- a/content/explorer/about_the_project/_index.md +++ b/content/explorer/v1/about/_index.md @@ -3,7 +3,8 @@ title: About the InfluxDB 3 Explorer project description: Learn about Explorer, the user interface and query tool for InfluxDB 3. menu: explorer_v1: - name: About the project + name: About Explorer + parent: InfluxDB 3 Explorer weight: 10 --- Explorer is the user interface compononent of the InfluxDB 3 platform. It makes visual management of databases and tokens straightforward, while also being an easy way to get started querying. It is fully featured for Core and Enterprise, while bringing query support for InfluxDB Cloud Serverless and InfluxDB Clustered. diff --git a/content/explorer/v1/get-started/_index.md b/content/explorer/v1/get-started/_index.md new file mode 100644 index 000000000..1622b20db --- /dev/null +++ b/content/explorer/v1/get-started/_index.md @@ -0,0 +1,13 @@ +--- +title: Get started using InfluxDB 3 Explorer +description: Follow steps to get started using InfluxDB 3 Explorer. +menu: + explorer_v1: + name: Get started + parent: InfluxDB 3 Explorer + weight: 30 +--- + +Follow steps to get started using InfluxDB 3 Explorer. + +{{< page-nav next="/explorer/v1/get-started/connect/" >}} diff --git a/content/explorer/v1/get-started/connect.md b/content/explorer/v1/get-started/connect.md new file mode 100644 index 000000000..828518756 --- /dev/null +++ b/content/explorer/v1/get-started/connect.md @@ -0,0 +1,11 @@ +--- +title: Connect to a server +description: + Use InfluxDB 3 Explorer to connect to an InfluxDB 3 server. +menu: + explorer_v1: + parent: Get started +weight: 10 +--- + +Use InfluxDB 3 Explorer to connect to an InfluxDB 3 server. \ No newline at end of file diff --git a/data/products.yml b/data/products.yml index d427e7ffc..44c2f94e3 100644 --- a/data/products.yml +++ b/data/products.yml @@ -108,6 +108,20 @@ influxdb_cloud: - How is Cloud 2 different from Cloud Serverless? - How do I manage auth tokens in InfluxDB Cloud 2? +explorer: + name: InfluxDB 3 Explorer + namespace: explorer + menu_category: other + list_order: 4 + versions: [v1] + latest: v1.0 + latest_patches: + v1: 1.0.0 + ai_sample_questions: + - How do I use InfluxDB 3 Explorer to visualize data? + - How do I create a dashboard in InfluxDB 3 Explorer? + - How do I query data using InfluxDB 3 Explorer? + telegraf: name: Telegraf namespace: telegraf