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

doc/subscriber_guide: add Email notifications section #573

Merged
merged 1 commit into from
Sep 24, 2024

Conversation

JenySadadia
Copy link
Collaborator

Explain KCIDB email notifications.

@JenySadadia
Copy link
Collaborator Author

JenySadadia commented Sep 12, 2024

@spbnick Is developer guide the correct place to mention email notifications or should I add this section to the submitter guide?

@JenySadadia JenySadadia changed the title doc/developer_build: add Email notifications section doc/developer_guide: add Email notifications section Sep 12, 2024
@spbnick
Copy link
Collaborator

spbnick commented Sep 12, 2024

I think this kind of info needs a new file - the docs for the consumers of our information, that is kernel and test maintainers and developers, plus possibly CI developers and maintainers. The "Developer Guide" is for developers of KCIDB. Perhaps we should call it subscriber_guide.md.

@JenySadadia
Copy link
Collaborator Author

OK, I'll add a new page.

Copy link
Collaborator

@spbnick spbnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, Jeny! This looks good. I would only like to see better formatting of the Markdown source, where possible, as its whole point (ok, maybe not the whole, but most) is to be readable as is, and long lines are not that readable.

And another nitpick: since the subscriber guide did not exist before your commit, the correct commit subject would look something like this: doc: Add a submitter guide.

doc/subscriber_guide.md Show resolved Hide resolved
doc/subscriber_guide.md Outdated Show resolved Hide resolved
Add a subscriber guide to explain `Email notifications`.

Signed-off-by: Jeny Sadadia <[email protected]>
Copy link
Collaborator

@spbnick spbnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you, Jeny!

@spbnick spbnick merged commit ab03856 into main Sep 24, 2024
6 checks passed
@spbnick spbnick deleted the email-report-docs branch September 24, 2024 08:54
@JenySadadia JenySadadia changed the title doc/developer_guide: add Email notifications section doc/subscriber_guide: add Email notifications section Sep 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants