search

elastic / opentelemetry

Get started with our Elastic Distros of OpenTelemetry
4 stars 4 forks source link

Create index.md for github pages #4

Open mlunadia opened 1 month ago

mlunadia commented 1 month ago

For github pages to work we need to create an index.md page that captures an navegable overview of the EDOT ecosystem.

The index.md will be picked up as the landing page for https://elastic.github.io/opentelemetry/

Ideally we want to have an index page that can get users to the right place without having to read too much.

An example index could be (this is a quick example with a quick review not the actual thing we should do)

Welcome to Elastic Distributions for OpenTelemetry

Introduction

Welcome to the official documentation site for the OpenTelemetry integration with Elastic. This GitHub page aims to provide comprehensive information, guides, and resources to help you get started and make the most out of OpenTelemetry with Elastic.

Table of Contents

Overview

OpenTelemetry is a collection of tools and SDKs that you can use to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) for analysis. The Elastic integration with OpenTelemetry allows you to send this telemetry data to Elastic for advanced analysis and visualization.

Getting Started

To get started with OpenTelemetry and Elastic, follow these steps:

  1. Prerequisites: Ensure you have the required tools and dependencies installed.
  2. Installation: Follow the installation guide to set up the different Elastic Distributions for OpenTelemetry.
  3. Configuration: Configure your OpenTelemetry setup to work with Elastic.
  4. Usage: Learn how to use the different EDOT components to send data to Elastic.

Installation

To install the necessary components for using OpenTelemetry with Elastic, refer to the Installation Guide.

Configuration

lorem ipsum...

Contributing

We welcome contributions from the community. If you want to contribute to this project, please read our Contributing Guide for more information.

lorem ipsum

License

EDOT are licensed under the XYZ License. See the LICENSE file for details, lorem ipsum

Contact

If you have any questions or need further assistance, feel free to open an issue on GitHub or reach out to the maintainers.

mdbirnstiehl commented 2 weeks ago

@mlunadia I found that we can use the readme.md file as the index if we update the Pages settings. Under Build and deployment, if we change the Source to Deploy from a branch, and change the folder to *root it publishes the current main branch readme.md file as the index. I tested this out, and it appears to be working (i pulled it down in case you didn't want to use this approach). If this works for you, we can update those settings to publish the pages and close this issue.

mlunadia commented 2 weeks ago

Done, waiting for the deployment to go through.

mdbirnstiehl commented 2 weeks ago

Looks like it's working! I'll need to update the components page since the flow charts don't appear to be supported in github pages (at least the way they are deployed right now). I'll look into that.

mdbirnstiehl commented 1 week ago

Marking this as done for now since we have the readme acting as the main page for GitHub pages.

mlunadia commented 1 week ago

@mdbirnstiehl I'm working on giving you merge privileges, can we keep this one open until we can get some basic navigability in the form of a menu