Skip to content

Added docs for Grafana, editing a cluster, the API tab in an instance/cluster, etc. - #386

Merged
BboyAkers merged 5 commits into
mainfrom
fabric-docs-updates
Nov 11, 2025
Merged

BboyAkers merged 5 commits into
mainfrom
fabric-docs-updates

Conversation

@BboyAkers

@BboyAkers BboyAkers commented Nov 7, 2025 •

Copy link
Copy Markdown
Contributor

Overview

Added docs for:

  • Using the Harper Grafana plugin
  • Editing a cluster
  • How to use the API tab in an instance/cluster

Additional Info

The "New Application" page I documented here in an earlier PR. Is this sufficient or do we want more documentation for this page?
https://docs.harperdb.io/fabric/managing-applications

Comment thread release-notes-data.json Resolved
Comment thread fabric/api-documentation.md Resolved
Comment thread fabric/api-documentation.md Resolved
Comment thread fabric/grafana-integration.md Resolved
Comment thread fabric/grafana-integration.md Resolved
Comment thread fabric/api-documentation.md Resolved
Comment thread fabric/grafana-integration.md Resolved

@cb1kenobi cb1kenobi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@BboyAkers
BboyAkers merged commit a999339 into main Nov 11, 2025
5 checks passed
@BboyAkers
BboyAkers deleted the fabric-docs-updates branch November 11, 2025 18:46

## Accessing the API Documentation

To access the API documentation, navigate to the following URL in your web browser:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To access the API documentation, navigate to the following URL in your web browser:
To access the API documentation, navigate to the `APIs` tab in a specific Cluster.

Comment thread fabric/api-documentation.md Resolved
To authorize API requests, you need to include a valid basic authentication header or bearer authentication token.

1. Click on the "Authorize" button in the Swagger Documentation UI.
2. Choose your preferred authentication method (Basic or Bearer) and enter your credentials or token.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you include a note where a user may get these credentials or tokens from? Like is this something they created when they instantiated the cluster? Maybe relate or link it back to another part of the docs when they created the details to jog their memory.

Comment thread fabric/grafana-integration.md Outdated

# Setup Grafana Integration with Harper

Grafana is an observability platform for monitoring and visualizing metrics, logs, and traces. Harper provides a plug-in to integrate with Grafana for enhanced analytics and visualization capabilities.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Grafana is an observability platform for monitoring and visualizing metrics, logs, and traces. Harper provides a plug-in to integrate with Grafana for enhanced analytics and visualization capabilities.
Grafana is an observability platform for monitoring and visualizing metrics, logs, and traces. Harper provides a plugin to integrate with Grafana for enhanced analytics and visualization capabilities.


Grafana is an observability platform for monitoring and visualizing metrics, logs, and traces. Harper provides a plug-in to integrate with Grafana for enhanced analytics and visualization capabilities.

To install the Harper Grafana integration:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To install the Harper Grafana integration:
To install the Harper Grafana plugin:


To install the Harper Grafana integration:

1. Navigate to Harper's plug-in inside the [Grafana marketplace](https://grafana.com/grafana/plugins/harperfast-harper-datasource/).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Navigate to Harper's plug-in inside the [Grafana marketplace](https://grafana.com/grafana/plugins/harperfast-harper-datasource/).
1. Navigate to the official Grafana marketplace [Harper plugin](https://grafana.com/grafana/plugins/harperfast-harper-datasource/).

@Ethan-Arrowood

Copy link
Copy Markdown
Member

My timing today is horrible; 0/2 on PR reviews before they get merged 🤦‍♂️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants