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.

Sign up for GitHub

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

Jump to bottom

Expand the bucket spec documents #13

Closed
afrittoli opened this issue Jan 25, 2022 · 3 comments
Closed

Expand the bucket spec documents #13

afrittoli opened this issue Jan 25, 2022 · 3 comments
Assignees
@afrittoli
Labels
spec Specification - Core CDEvents
Milestone
v0.1

Comments

@afrittoli
Copy link
Contributor

Expand the spec documents for each bucket to include some extra information:

  • Overview (about the bucket)
  • Data model: describe the entities and their fields, using link where applicable when a field refers to a different entity. E.g. an Environment has an ID. A Deployment may refer to an environment by ID.
  • Activities / Events: for each entity in the bucket, define which events are available. Each event should include a description, link to use cases, example about when to send and not send the event, a link to the data model, a list or table of mandatory / optional fields

Examples in the spec may also refer to specific platforms. Fields should include a type, examples of values and link to use cases.
@afrittoli afrittoli added the spec Specification - Core CDEvents label Jan 25, 2022
@afrittoli afrittoli added this to the v0.1 milestone Jan 25, 2022
@afrittoli afrittoli mentioned this issue Jan 26, 2022
Closed
@afrittoli afrittoli self-assigned this Jun 28, 2022
afrittoli added a commit to afrittoli/cdevents-spec that referenced this issue Jul 7, 2022
@afrittoli
Format source code events same as core
aca066d 
Reformat the source code version control stage page to match what
done for the core stage. No spec changes.

Part of cdevents#13

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
@afrittoli afrittoli mentioned this issue Jul 7, 2022
Merged
afrittoli added a commit that referenced this issue Jul 8, 2022
@afrittoli
Format source code events same as core (#52)
f990094 
Format source code events same as core

Reformat the source code version control stage page to match what
done for the core stage. No spec changes.

Part of #13

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
@afrittoli
Copy link
Contributor Author

afrittoli commented Aug 23, 2022 •
edited
Loading

The scope of this issue for v0.1 is - expand the data model as much as needed for cdevents/community#29

Design work: https://hackmd.io/cFw0xO6XSwGwIoJ78Re91A

@afrittoli
Copy link
Contributor Author

afrittoli commented Aug 23, 2022 •
edited
Loading

@afrittoli
Copy link
Contributor Author

Incident events are moved to the next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@afrittoli afrittoli

Labels
spec Specification - Core CDEvents
Projects
CDEvents Releases
Status: Done
Milestone
v0.1
Development

No branches or pull requests
1 participant
@afrittoli