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

2U private event bus how-to improvements #327

Open
robrap opened this issue Jun 12, 2023 · 0 comments
Open

2U private event bus how-to improvements #327

robrap opened this issue Jun 12, 2023 · 0 comments
Labels
event-bus Work related to the Event Bus.

Comments

@robrap
Copy link
Contributor

robrap commented Jun 12, 2023

Here is the private how-to: https://2u-internal.atlassian.net/wiki/spaces/AT/pages/174555142/How+to+Use+the+Event+Bus

This ticket captures a variety of feedback captured from others at different times: Note: Some of this could be ticketed separately.

  • Resolve any comments on the doc.
  • Does the private how-to mix documentation types? The public one did, but this one may be ok.
  • Can tips from Doc for writing brief and useful docs openedx/docs.openedx.org#338 shrink any paragraphs in the document?
    • Feedback: "Too much prose. Needs bullets and monospace."
  • Are there any code examples that can be copied directly into the doc, rather than (or in addition) to references via links? (This may no longer apply.)
    • "Copy/paste all commands and code, with links to PRs."
    • Consider what parts could be automated in k8s-app-creator and cookie-cutter tools. Can/should this be tasked?
  • Also see Move and improve event bus public how-to openedx/openedx-events#238 for improvements to the public how-to.
    • References to the public how-to will need to be updated when this is complete.
@robrap robrap added this to Arch-BOM Jun 12, 2023
@robrap robrap converted this from a draft issue Jun 12, 2023
@robrap robrap added the event-bus Work related to the Event Bus. label Jun 12, 2023
@jristau1984 jristau1984 moved this to Backlog in Arch-BOM Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
event-bus Work related to the Event Bus.
Projects
Status: Backlog
Development

No branches or pull requests

1 participant