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

Take 2 of readme reset PR #400

Merged
merged 8 commits into from
Mar 26, 2019
Merged

Take 2 of readme reset PR #400

merged 8 commits into from
Mar 26, 2019

Conversation

webmat
Copy link
Contributor

@webmat webmat commented Mar 22, 2019

Fun facts:

In this PR (other than dep. PR):

  • Rewrite README.md to be contributor-centric.
  • Redirect people to elastic.co website for ECS reference doc.
  • Guide people to various contributor-centric documentation
  • Document generated files
  • Align the generated/ecs/*.yml file names to the corresponding variables in the code generators
  • Rename schemas/format.md to schemas/README.md so it renders by default, when visiting directory on GitHub

TODO

Release

Last minute adjustments needed on this PR, once the ECS docs are pushed to the website.

  • Replace links to main website:
    • Link to top of documentation section, in README.md
    • Link to "Guidelines and Best Practices", in CONTRIBUTING.md

@ruflin
Copy link
Contributor

ruflin commented Mar 25, 2019

@webmat Ok if I start reviewing when the others are merged?

@webmat
Copy link
Contributor Author

webmat commented Mar 25, 2019

@ruflin Of course. Have you had time to review #393? ;-)

@webmat
Copy link
Contributor Author

webmat commented Mar 25, 2019

@ruflin This is ready for final review. You can even try both links. The ECS docs are live ;-)

@webmat webmat merged commit fa81fa6 into elastic:master Mar 26, 2019
webmat added a commit to webmat/ecs that referenced this pull request Mar 26, 2019
…oc (elastic#400)

* readme no longer contains the field definitions
* readme now directs people to the main website, for the official ECS documentation
* Introduce `make legacy_use_cases` to generate the use cases (they were previously generated at the same time as the readme)
* Document generated files a bit
* contributing guidelines now point people to a page in the docs, to reduce content duplication 
* renamed the two intermediary in memory representations to match the variable names used in the code
webmat added a commit that referenced this pull request Mar 27, 2019
…tributor-centric doc (#405)

* readme no longer contains the field definitions
* readme now directs people to the main website, for the official ECS documentation
* Introduce `make legacy_use_cases` to generate the use cases (they were previously generated at the same time as the readme)
* Document generated files a bit
* contributing guidelines now point people to a page in the docs, to reduce content duplication 
* renamed the two intermediary in memory representations to match the variable names used in the code
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants