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

[Eventgrid] documentation issues #15940

Closed
12 tasks done
rakshith91 opened this issue Dec 29, 2020 · 0 comments · Fixed by #16986
Closed
12 tasks done

[Eventgrid] documentation issues #15940

rakshith91 opened this issue Dec 29, 2020 · 0 comments · Fixed by #16986
Assignees
Labels
blocking-release Blocks release Client This issue points to a problem in the data-plane of the library. Event Grid Messaging Messaging crew
Milestone

Comments

@rakshith91
Copy link
Contributor

rakshith91 commented Dec 29, 2020

  • Readme
  • explain Difference between Event Grid events vs Cloud Events.
  • update the sample of consuming event to include values
  • add an example to send multiple events (batch events)
  • Inconsistent terms in readme “hostname” and at portal “endpoint”, should be consistent
  • Ref doc
  • confusion in required vs optional in Event Grid and Cloud event schemas.
  • data version is not marked as required
  • “Cloud event doc id is optional, but “combination of source and id should be unique” was confusing [EventGrid] Small doc updates for id parameter #15835
  • Topic is not listed as required in the ref doc for event grid domain
  • Need better explanation on event schema parameters with examples of typical values
  • Samples
  • Explain/ add comments about env variables and how to add them - just add a stackoverflow issue about envars as an explanation
  • Misc
  • Make sure optional and non optional are well documented
  • Document sending and receiving multistage decode of events better. try receiving a QueueEvent for instance and if documentation explains it. Also, give better explanation on Readme.
@rakshith91 rakshith91 added Client This issue points to a problem in the data-plane of the library. Event Grid labels Dec 29, 2020
@lmazuel lmazuel added this to the [2021] March milestone Jan 13, 2021
@rakshith91 rakshith91 self-assigned this Feb 12, 2021
@rakshith91 rakshith91 added the blocking-release Blocks release label Feb 23, 2021
@lmazuel lmazuel added the Messaging Messaging crew label Apr 12, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
blocking-release Blocks release Client This issue points to a problem in the data-plane of the library. Event Grid Messaging Messaging crew
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants