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

docs: improve documentation around contribution #10825

Merged
merged 15 commits into from
Mar 28, 2022
Merged

docs: improve documentation around contribution #10825

merged 15 commits into from
Mar 28, 2022

Conversation

sspaink
Copy link
Contributor

@sspaink sspaink commented Mar 16, 2022

Our contribution guidelines are a bit hidden in the README, updating the document to put more focus on it by adding a big button to jump to the section. We can change the format/color of it I just made it as big and obvious as possible. Also the CONTRIBUTING.md starts with sign the CLA which isn't that welcoming, updating it to start with more friendly text.

image

I referenced the contributing text from https://github.com/influxdata/influxdb/blob/master/CONTRIBUTING.md to keep them similar.

@sspaink sspaink requested a review from popey March 16, 2022 13:01
@telegraf-tiger telegraf-tiger bot added the chore label Mar 16, 2022
@sspaink sspaink changed the title chore: improve documentation around contribution docs: improve documentation around contribution Mar 16, 2022
@sspaink sspaink added docs Issues related to Telegraf documentation and configuration descriptions and removed chore labels Mar 21, 2022
@sspaink sspaink marked this pull request as ready for review March 21, 2022 15:18
Copy link
Contributor

@MyaLongmire MyaLongmire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
sspaink and others added 7 commits March 21, 2022 11:11
Co-authored-by: Joshua Powers <powersj@fastmail.com>
Co-authored-by: Joshua Powers <powersj@fastmail.com>
Co-authored-by: Joshua Powers <powersj@fastmail.com>
Co-authored-by: Joshua Powers <powersj@fastmail.com>
@telegraf-tiger
Copy link
Contributor

@sspaink sspaink added the ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review. label Mar 24, 2022
@sjwang90
Copy link
Contributor

This looks great! I'm going to update the docs.influxdata.com contributing page when this gets merged

@powersj powersj merged commit 1f7cd1d into master Mar 28, 2022
@powersj powersj deleted the updatereadme branch March 28, 2022 15:47
MyaLongmire pushed a commit that referenced this pull request Apr 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues related to Telegraf documentation and configuration descriptions ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants