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

Clarify use of Slug in notice markdown #10

Open
ajh0912 opened this issue Jan 6, 2022 · 0 comments
Open

Clarify use of Slug in notice markdown #10

ajh0912 opened this issue Jan 6, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ajh0912
Copy link

ajh0912 commented Jan 6, 2022

Within the template, 202X-MM-DD-slug.md.template:
Slug: <NAME OF IMPACTED PRODUCT OR COMPONENT>

Within 2021-12-09-log4j.md:
Slug: log4j

What relies on Slug: being present in each notice? Is it used within notifications, or pelican etc? I see the URL doesn't rely on it and instead uses the markdown file name https://bugalert.org/content/notices/2021-12-09-log4j.html, nor do I see it in the Atom feed.

I'm just wondering how to deal with multiple notices for the same software, over time - as normally a slug would be a globally unique. Does that field need to be present here? Or if there is a dependency on it, maybe it should be the same as the base filename of the notice (to ensure it is unique):
Slug: 2021-12-09-log4j

Also, maybe clarify now what to do if there are multiple issues for a single product in a single day - I would say retroactively changing an existing notice to include a second issue would not be good unless there is a notification for major revisions to a notice. So a second notice should be made, would it be 2021-12-09_2-log4j etc.

Would it be worth enabling GitHub Discussions for minor questions?

@sullivanmatt sullivanmatt added the documentation Improvements or additions to documentation label Jan 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants