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

Split up README into seperate docs #13

Open
evanderkoogh opened this issue Jul 3, 2023 · 4 comments
Open

Split up README into seperate docs #13

evanderkoogh opened this issue Jul 3, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@evanderkoogh
Copy link
Owner

Right now especially the configuration section explains a lot of how Open Telemetry works to explain what to configure and how.

This can all be put into a separate doc that we can refer to, so we can keep the config section clean.

@evanderkoogh evanderkoogh added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 3, 2023
@abhikumar63
Copy link

I would like to contribute to this project.
I will look through the documentation and will separate it accordingly so that no section is ignored or left.

@evanderkoogh
Copy link
Owner Author

That would be amazing.. That would give me some time to jump on chipping away at adding auto-instrumentation support for last few things that are missing.

Just create a docs folder with a markdown file in it. And give me a shout if you need any help.

@abhikumar63
Copy link

Thanks for the opportunity.

  • First please tell me if you need separate files for all the sub topics or just 1 file in the docs folder.
  • Do you want me improvise the documentation or just copy the following text.

@evanderkoogh
Copy link
Owner Author

Hey.. I would probably start with just everything in one document, or maybe split out the sampling. But it is always easy enough to split things out later..

And I am more than happy to leave the content of the docs up to you. Feel free to either copy my text, but certainly make any improvements you want. I wrote it in one sitting late at night and I am too close to the code and concepts for it to be a great explainer for people new to the space.

Don't worry about making any mistakes.. I'll be reviewing it anyway for accuracy, so don't feel any pressure to keep things the way I wrote them.

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants