Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get Documentation to a useful state #109

Closed
4 of 9 tasks
Spazzy757 opened this issue Apr 26, 2024 · 0 comments
Closed
4 of 9 tasks

Get Documentation to a useful state #109

Spazzy757 opened this issue Apr 26, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation EPIC roadmapping epic

Comments

@Spazzy757
Copy link
Contributor

Spazzy757 commented Apr 26, 2024

Description

we need to get the documentation to a state where people can start using Aether. I would propose the following for the first iteration:

  • Overall description of what Aether is and how it works
  • Installation guide
  • Getting started guide for AWS #120
  • Getting Started guide for GCP
  • Setting up a dashboard with grafana
  • How to write a Exporter Plugin
  • How to write a Source Plugin
  • Documentation on emission data and where it is coming from
  • Update Readme to link website and various badges

fixes: https://github.com/re-cinq/re-cinq/issues/72

@Spazzy757 Spazzy757 added documentation Improvements or additions to documentation EPIC roadmapping epic labels Apr 26, 2024
@muemich muemich closed this as completed Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation EPIC roadmapping epic
Projects
None yet
Development

No branches or pull requests

3 participants