Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Doc improvements #593

Merged
merged 26 commits into from
Apr 28, 2020
Merged

Doc improvements #593

merged 26 commits into from
Apr 28, 2020

Conversation

jmlrt
Copy link
Member

@jmlrt jmlrt commented Apr 22, 2020

  • 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

This part wil be done in #598:

  • Improve FAQ
    • How to create umbrella chart for Elasticsearch
    • How to create dedicated roles with Elasticsearch charts
    • Metricbeat bet practices
    • How to automate API calls (ILM, objects imports, ...) after deployment
    • How to disable default values in charts
  • Add README.md for every configuration examples
  • Add a note about ECK

@jmlrt jmlrt force-pushed the doc-improvements branch 6 times, most recently from b2001e4 to b431df2 Compare April 22, 2020 15:58
@jmlrt jmlrt force-pushed the doc-improvements branch 2 times, most recently from e3d7df4 to 2f36dad Compare April 22, 2020 21:13
@jmlrt jmlrt requested a review from mgreau April 24, 2020 17:40
Copy link
Member

@mgreau mgreau left a 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

BREAKING_CHANGES.md Outdated Show resolved Hide resolved
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
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

done in 8e1d549

@jmlrt jmlrt mentioned this pull request Apr 27, 2020
8 tasks
Copy link
Member

@mgreau mgreau left a comment

Choose a reason for hiding this comment

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

LGTM 🏅

@jmlrt jmlrt merged commit db84a6c into elastic:master Apr 28, 2020
@jmlrt jmlrt deleted the doc-improvements branch April 28, 2020 06:33
jmlrt added a commit to jmlrt/helm-charts that referenced this pull request Apr 28, 2020
@jmlrt jmlrt added v7.7.0 enhancement New feature or request labels Apr 28, 2020
jmlrt added a commit that referenced this pull request Apr 28, 2020
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
@jmlrt jmlrt mentioned this pull request Oct 28, 2020
This was referenced Nov 17, 2020
@jmlrt jmlrt mentioned this pull request Feb 8, 2021
This was referenced Mar 15, 2021
@jmlrt jmlrt mentioned this pull request May 25, 2021
@jmlrt jmlrt mentioned this pull request Mar 8, 2022
@jmlrt jmlrt mentioned this pull request Apr 21, 2022
This was referenced Sep 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request v7.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants