Skip to content

Conversation

@webmat
Copy link
Contributor

@webmat webmat commented Mar 21, 2019

This PR has been replaced by #400

In this PR:

  • move generated README.md to generated/legacy/README.md
  • point to the official docs on the main site
  • 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

  • Replace links to main website:
    • Link to top of documentation section, in README.md
    • Link to "Guidelines and Best Practices", in CONTRIBUTING.md
  • Actually, perhaps we should move the old generated README.md to generated/legacy for now

@webmat
Copy link
Contributor Author

webmat commented Mar 21, 2019

Reviewers can navigate this new readme and other files at https://github.com/webmat/ecs/tree/readme-redirect

@webmat webmat requested review from MikePaquette and ruflin March 21, 2019 18:58
@webmat webmat changed the title Reset readme, now that docs will be on official website WIP Reset readme, now that docs will be on official website Mar 21, 2019
@webmat webmat changed the title WIP Reset readme, now that docs will be on official website Reset readme, now that docs will be on official website Mar 21, 2019
@ruflin
Copy link
Contributor

ruflin commented Mar 22, 2019

What is the reason you keep all the old files around? Can't we just delete them and in case we need them again we use git?

### Deprecated

* Move old `fields.yml` file from the root of the repo to `generated/legacy`. #386
* Move the old all-in-one README.md to generated/legacy/. #395
Copy link
Contributor

Choose a reason for hiding this comment

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

I would not put changing docs into the README.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree in principle. However I thought since the official ECS reference used to be this file, it's disappearance was worth a mention in the changelog

@webmat
Copy link
Contributor Author

webmat commented Mar 22, 2019

Yeah I was on the fence on the old files. I'll delete them and all of the code associated.

@webmat
Copy link
Contributor Author

webmat commented Mar 22, 2019

Old readme is now deleted.

I'll get rid of the other generated files in another PR, since this PR is meant to be one of the concrete steps of the asciidoc deployment to the main site. I don't want it to contain too much.

@webmat webmat mentioned this pull request Mar 22, 2019
3 tasks
@webmat
Copy link
Contributor Author

webmat commented Mar 22, 2019

This PR was getting a bit too big for my taste, for something that should be done on the day of the deployment to the main website.

I'm closing it in favour of the trimmed down #400

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