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

Build: new notification system for build notifications #10598

Closed
agjohnson opened this issue Aug 2, 2023 · 3 comments · Fixed by #10890
Closed

Build: new notification system for build notifications #10598

agjohnson opened this issue Aug 2, 2023 · 3 comments · Fixed by #10890
Assignees
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@agjohnson
Copy link
Contributor

agjohnson commented Aug 2, 2023

This came from a discussion at our offsite. I put up an internal discussion at https://github.com/readthedocs/meta/discussions/126 in case there is anything left to discuss. But if not, starting with the build notification changes is probably where we'd start with this work I imagine.

To distill this conversation heavily:

We want to overhaul the way we output notifications and messages from the build. This would replace:

  • Error strings output from exceptions during build
  • Error strings output from commands during build
  • Template logic showing blocks in templates for error/info messages

Instead:

  • During a build, multiple messages could be output from the build.
  • Each message would have more attributes than django notification messages.
  • Each message would have richer content than our error messages now, probably HTML so we can actually write proper links.
  • We'd track state around the notification, and dismiss notifications when underlying conditionals resolve

#3399 was the original start of this, but I hesitate to reuse that issue as it was used for multiple changes already. Perhaps it's best to close that up and move the relevant discussion.

@agjohnson agjohnson added Improvement Minor improvement to code Needed: design decision A core team decision is required labels Aug 2, 2023
@humitos humitos changed the title Build: new notification system for build notificaitons Build: new notification system for build notifications Aug 8, 2023
@agjohnson
Copy link
Contributor Author

Also noted from today, latex pdf builds could emit a warning when we get a non-zero exit code.

@humitos
Copy link
Member

humitos commented Oct 31, 2023

I reviewed all the issues linked and wrote down some thoughts that I pasted at https://gist.github.com/humitos/e9782439bee9ad6c5897a5557c163244

This is not the final version, but just some ideas / concepts and notes that I took while reading all those issues. We have a lot of duplicated information around and I wanted to summarize them all in just one document.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants