Skip to content

Commit

Permalink
docs: fix the alerts in markdown
Browse files Browse the repository at this point in the history
GitHub has apparently changed syntax for no good reason…

Related to https://fosstodon.org/@FrostyX/112552088714938785

Signed-off-by: Matej Focko <[email protected]>
  • Loading branch information
mfocko committed Jun 3, 2024
1 parent 89d441d commit 39b1011
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,17 @@ This repo is used to document research performed by the Packit Team.
category.
1. Please create a new directory in the [research](research/) directory.
1. Create an `index.md` document in that directory.
> **Note**
> In case you're working on a follow-up research, feel free to just add a new
> Markdown file next to already existing research.
1. Make sure your `index.md` contains a clear description of what the outcome is
from your research topic: ideally propose what the next steps should be.
It's completely fine to tell that the technology is not interesting to us
and there are no further actions.
1. Add everything related to your topic in the directory.
1. Open a pull request.

> [!NOTE]
> In case you're working on a follow-up research, feel free to just add a new
> Markdown file next to already existing research.
### Template for research

```md
Expand All @@ -42,7 +43,7 @@ authors: ‹Kerberos logins of authors, e.g. login or [login_a, login_b]›
## Next steps
```

> **Warning**
> [!WARNING]
> Authors are not checked against the list of authors as with the blog posts,
> keeping the authors in the attributes of research is just a courtesy to avoid
> unnecessary _git blaming_.

0 comments on commit 39b1011

Please sign in to comment.