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

Improve Documentation for connectors #309

Open
2 tasks
s0nicboOm opened this issue Oct 9, 2023 · 6 comments
Open
2 tasks

Improve Documentation for connectors #309

s0nicboOm opened this issue Oct 9, 2023 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest

Comments

@s0nicboOm
Copy link
Contributor

s0nicboOm commented Oct 9, 2023

Summary

Improve documentation for numalogic repository. Specifically, add a connectors tab in the User Guide to help them use the two fetcher classes we have namely Prometheus and Druid.

It could be something along this structure:

-> User Guide
----> Connectors
-------> Prometheus
-------> Druid

The docs directory is where most of the work needs to be done, and then the mkdocs.yml file needs to be updated to reflect any structure-level changes needed.

Tasks

@s0nicboOm s0nicboOm added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest labels Oct 9, 2023
@Ijeoma-Onwuka
Copy link

I would love to work on this.

@Subhashini014
Copy link

could you please assign me this issue.

@ab93 ab93 changed the title Improve Documentation Improve Documentation for connectors Oct 17, 2023
@ab93
Copy link
Member

ab93 commented Oct 17, 2023

I would love to work on this.

Hi @Ijeoma-Onwuka sure, I am assigning this to you. I also added some more information, and hopefully it is now more clear. Let me know if you have any issues.

@ab93
Copy link
Member

ab93 commented Oct 17, 2023

could you please assign me this issue.

Hi @Subhashini014 do you want to take up #169 ? Otherwise, we have other doc related issues that I can assign you to. Let me know :)

@Subhashini014
Copy link

yes I would take up the #169 issue.

@ab93
Copy link
Member

ab93 commented Oct 18, 2023

@Subhashini014 great, could you comment on that issue, so that I can assign you there?

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 enhancement New feature or request good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

No branches or pull requests

4 participants