cloudfoundry / docs-loggregator

Apache License 2.0
3 stars 34 forks source link

Document envelope types #81

Closed rroberts2222 closed 1 year ago

rroberts2222 commented 1 year ago

This documentation of envelope types exists already in the loggregator-api README. Adding it to the main documentation to make it easier to find and clear up any confusion.

cf-gitbot commented 1 year ago

We have created an issue in Pivotal Tracker to manage this. Unfortunately, the Pivotal Tracker project is private so you may be unable to view the contents of the story.

The labels on this github issue will be updated when the story is started.

anita-flegg commented 1 year ago

@chombium, Very good point. Maintenance is a big issue. @rroberts2222, Would you consider withdrawing these PRs and changing to linking to the README? Thanks :)

Then again, I guess the right answer depends on how often these particular items tend to change. If they pretty much never change, then maybe having them in the main docs makes sense. I don't know the answer -- at first glance, they look like they might not change much ...

rroberts2222 commented 1 year ago

closing since a change adding a link to the README was added in commit https://github.com/cloudfoundry/docs-loggregator/commit/6c985d9c1d30135a5f82147da7924bec67580d72