-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Conversation
b2001e4
to
b431df2
Compare
e3d7df4
to
2f36dad
Compare
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.
Adding a couple of comments, for now, I will continue reviewing later today
CONTRIBUTING.md
Outdated
If you haven't already you will need to sign the [CLA][] before your pull | ||
request can be reviewed and merged. | ||
|
||
## Branches workflow |
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 should re-use some sentences from https://github.com/elastic/elasticsearch/blob/master/CONTRIBUTING.md#contributing-code-and-documentation-changes
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.
The Kibana guide is also great https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md#how-we-use-git-and-github
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.
done in 8e1d549
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.
LGTM 🏅
Doc improvements
Doc improvements - Reformat all `README.md` files - Fix typos and missing syntaxes) - Use Markdown implicit link names - Sort values in configuration tables - Limit lines to 80 characters (except for code blocks and tables) - Add table of content - Fix default values descriptions - Move testing instructions to `CONTRIBUTING.md` doc - Move breaking changes notices to `BREAKING_CHANGES.md` doc
README.md
filesCONTRIBUTING.md
docBREAKING_CHANGES.md
docThis part wil be done in #598:
Improve FAQHow to create umbrella chart for ElasticsearchHow to create dedicated roles with Elasticsearch chartsMetricbeat bet practicesHow to automate API calls (ILM, objects imports, ...) after deploymentHow to disable default values in chartsAddREADME.md
for every configuration examplesAdd a note about ECK