We believe that the best way to build software is to do it in close collaboration with the people who use it. We invite you to submit your ideas using the form below. Please be sure to include the problem for which you are solving and the benefits of implementing the idea.
We do our best to implement as many Ideas as we can. Our Product team will evaluate all submitted ideas in a timely manner and will disposition each into one of the following categories: will integrate into the product roadmap, further research is needed, unlikely to implement.
Thanks for collaborating with us!
The README.md
for the event-service
core application is blank:
https://github.com/chef/automate/tree/master/components/event-service
It would be great if this matched the other core application services' README.md
's [1] and had general information about the service.
[1]
https://github.com/chef/automate/tree/master/components/compliance-service#readme
https://github.com/chef/automate/tree/master/components/automate-gateway#readme
https://github.com/chef/automate/tree/master/components/config-mgmt-service#readme
https://github.com/chef/automate/tree/master/components/ingest-service#readme
Sure Austin. I take that as a feedback. For the context of this idea, considering that the details of event-feed readme is acceptable, I will mark this idea as complete.
@Ankur => That
events-service
README looks like what I was hoping to see.I would love to see this level of base-level developer documentation for every component. Currently, the following components are without any README content:
https://github.com/chef/automate/tree/master/components/applications-load-gen
https://github.com/chef/automate/tree/master/components/automate-builder-api-proxy
https://github.com/chef/automate/tree/master/components/automate-builder-api
https://github.com/chef/automate/tree/master/components/automate-builder-memcached
https://github.com/chef/automate/tree/master/components/automate-cds
https://github.com/chef/automate/tree/master/components/automate-cli
https://github.com/chef/automate/tree/master/components/automate-cs-bookshelf
https://github.com/chef/automate/tree/master/components/automate-cs-nginx
https://github.com/chef/automate/tree/master/components/automate-cs-oc-bifrost
https://github.com/chef/automate/tree/master/components/automate-cs-oc-erchef
https://github.com/chef/automate/tree/master/components/automate-elasticsearch
https://github.com/chef/automate/tree/master/components/automate-es-gateway
https://github.com/chef/automate/tree/master/components/automate-grpc
https://github.com/chef/automate/tree/master/components/automate-minio
https://github.com/chef/automate/tree/master/components/automate-pg-gateway
https://github.com/chef/automate/tree/master/components/automate-prometheus
https://github.com/chef/automate/tree/master/components/automate-scaffolding-go
https://github.com/chef/automate/tree/master/components/automate-scaffolding
https://github.com/chef/automate/tree/master/components/automate-workflow-nginx
https://github.com/chef/automate/tree/master/components/backup-gateway
https://github.com/chef/automate/tree/master/components/cereal-service
https://github.com/chef/automate/tree/master/components/data-feed-service
https://github.com/chef/automate/tree/master/components/event-feed-service
https://github.com/chef/automate/tree/master/components/event-gateway
https://github.com/chef/automate/tree/master/components/notifications-client
https://github.com/chef/automate/tree/master/components/notifications-service2
https://github.com/chef/automate/tree/master/components/pg-sidecar-service
https://github.com/chef/automate/tree/master/components/secrets-service
https://github.com/chef/automate/tree/master/components/user-settings-service
Hey Austin,
We have the changes covered at https://github.com/chef/automate/pull/5214/files. May I have your early feedback, please?