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

Publish event-bus-kafka settings docs (annotations) #139

Open
3 tasks
timmc-edx opened this issue Feb 28, 2023 · 0 comments
Open
3 tasks

Publish event-bus-kafka settings docs (annotations) #139

timmc-edx opened this issue Feb 28, 2023 · 0 comments
Labels
event-bus Work related to the Event Bus.

Comments

@timmc-edx
Copy link
Contributor

Documentation on the configuration options for event-bus-kafka are currently spread between code comments (rST annotations on Django settings), in-repo doc files, and Confluence. Some of the information is needlessly duplicated, and is likely to get out of sync. We should publish the setting annotations (since they are authoritative) as is done in edx-platform, and then link to them for reference from any set-up guides.

  • Set up ReadTheDocs for this repo
  • Set up repo to publish setting annotations
  • Deduplicate docs as necessary to point to the published annotations

We'll still want to have a sample config so we can highlight the essential settings, but this way we won't have to describe the details of all the settings in doc files. It will also allow us to avoid sending people into modules marked internal.

@timmc-edx timmc-edx moved this to Todo in Arch-BOM Feb 28, 2023
@timmc-edx timmc-edx added the event-bus Work related to the Event Bus. label Feb 28, 2023
@timmc-edx timmc-edx added this to the [Event Bus] Future milestone Feb 28, 2023
@robrap robrap added this to Arch-BOM Jun 13, 2023
@robrap robrap removed this from the [Event Bus] Future milestone Jun 13, 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
None yet
Development

No branches or pull requests

2 participants