-
Notifications
You must be signed in to change notification settings - Fork 18
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
Fix add_descriptions_to_readme.sh
script
#267
Conversation
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #267 +/- ##
==========================================
- Coverage 99.61% 94.52% -5.09%
==========================================
Files 14 15 +1
Lines 774 621 -153
==========================================
- Hits 771 587 -184
- Misses 2 34 +32
+ Partials 1 0 -1 ☔ View full report in Codecov by Sentry. |
@satk0 you seem to be using wrong master branch- instead of kuskoman/logstash-exporter, you are using your satk0/logstash-exporter main branch. could you fix that? |
@satk0 also, your script seems to be adding whitespaces in some empty lines |
README.md
Outdated
@@ -180,91 +184,107 @@ The binary executables are saved in the out directory. | |||
#### Example Usage |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we are duplicating the section. we should simplify it to just one repetition. or, instead, provide more detailed information
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point. I will just stick to only one repetition.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my newest commit I deleted the "Example Usage" section. Maybe this section could actually be used to show an example logstash exporter usage scenario? I think it might be helpful for any newcomer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think that running the application is documented enough, but if you want you can create examples dir
personally i dont think it is needed, people looking for this tool usually know what they are doing :p
Link #266
Resolves #268