Skip to content
This repository has been archived by the owner on Oct 9, 2024. It is now read-only.

Make markdown refs compatible with prettier #181

Merged
merged 2 commits into from
Jan 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Community Code of Conduct

Please see the official [Ansible Community Code of Conduct][CoC].
Please see the official [Ansible Community Code of Conduct][coc].

[CoC]:
[coc]:
Copy link
Member

Choose a reason for hiding this comment

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

I asked you not to do the lowercasing in another PR 🤦‍♂️ Why did you sneak it in anyway?

https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
4 changes: 2 additions & 2 deletions docs/changelog-fragments.d/158.misc.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Added changelog fragment management infrastructure using [Towncrier]
Added changelog fragment management infrastructure using [Towncrier][towncrier]
-- by {user}`webknjaz`

[Towncrier]: https://github.com/twisted/towncrier
[towncrier]: https://github.com/twisted/towncrier
4 changes: 2 additions & 2 deletions docs/changelog-fragments.d/161.misc.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Added [Sphinx] documentation generator and set up the CI
Added [Sphinx][sphinx] documentation generator and set up the CI
infrastructure for it -- by {user}`webknjaz`

[Sphinx]: https://github.com/twisted/towncrier
[sphinx]: https://github.com/twisted/towncrier
6 changes: 3 additions & 3 deletions docs/changelog-fragments.d/164.doc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Dropped the brackets from the changelog titles for the release sections.
We now don't strictly follow the release notes format suggested by [Keep
a Changelog] -- by {user}`webknjaz`
We now don't strictly follow the release notes format suggested by
[Keep a Changelog][keepachangelog] -- by {user}`webknjaz`

[Keep a Changelog]: https://keepachangelog.com/en/1.1.0/
[keepachangelog]: https://keepachangelog.com/en/1.1.0/
9 changes: 5 additions & 4 deletions docs/changelog-fragments.d/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
It is very important to maintain a log for news of how
updating to the new version of the software will affect
end-users. This is why we enforce collection of the change
fragment files in pull requests as per [Towncrier philosophy].
fragment files in pull requests as per
[Towncrier philosophy][towncrier-philosophy].

The idea is that when somebody makes a change, they must record
the bits that would affect end-users only including information
Expand All @@ -32,7 +33,7 @@ for the users to understand what it means.
combined with others, it will be a part of the "news digest"
telling the readers **what changed** in a specific version of
the library *since the previous version*. You should also use
[MyST Markdown] syntax for highlighting code (inline or block),
[MyST Markdown][myst-md] syntax for highlighting code (inline or block),
linking parts of the docs or external sites.
At the end, sign your change note by adding ```-- by
{user}`github-username``` (replace `github-username` with
Expand Down Expand Up @@ -73,7 +74,7 @@ See `pyproject.toml` for all available categories
(`tool.towncrier.type`).
```

[MyST Markdown]:
[myst-md]:
https://myst-parser.rtfd.io/en/latest/syntax/syntax.html
[Towncrier philosophy]:
[towncrier-philosophy]:
https://towncrier.rtfd.io/en/actual-freaking-docs/#philosophy
14 changes: 7 additions & 7 deletions docs/contributing/guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Towncrier

# Contributing docs

We use [Sphinx] to generate our docs website. You can trigger
We use [Sphinx][sphinx] to generate our docs website. You can trigger
the process locally by executing:

```shell-session
Expand All @@ -38,21 +38,21 @@ _______________________________________________________ summary ________________
congratulations :)
```

It is also integrated with [Read The Docs] that builds and
It is also integrated with [Read The Docs][rtd] that builds and
publishes each commit to the main branch and generates live
docs previews for each pull request.

The sources of the [Sphinx] documents use reStructuredText as a
The sources of the [Sphinx][sphinx] documents use reStructuredText as a
de-facto standard. But in order to make contributing docs more
beginner-friendly, we have integrated [MyST parser] allowing us
beginner-friendly, we have integrated [MyST parser][myst] allowing us
to also accept new documents written in an extended version of
Markdown that supports using Sphinx directives and roles.
{ref}`Read the docs <myst:intro/writing>` to learn more on how
to use it.

[MyST parser]: https://pypi.org/project/myst-parser/
[Read The Docs]: https://readthedocs.org
[Sphinx]: https://www.sphinx-doc.org
[myst]: https://pypi.org/project/myst-parser/
[rtd]: https://readthedocs.org
[sphinx]: https://www.sphinx-doc.org

```{include} ../changelog-fragments.d/README.md
```