Skip to content

Commit b035e64

Browse files
committed
Further use of Markdown extensions
1 parent 6d1ebef commit b035e64

File tree

7 files changed

+117
-88
lines changed

7 files changed

+117
-88
lines changed

doc/GUIDE_advanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ quit.
1818

1919
## The `stack --[no-]rsl-in-log` flag
2020

21-
(Since 2.7.6)
21+
[:octicons-tag-24: 2.7.6](https://github.com/commercialhaskell/stack/releases/tag/v2.7.6)
2222

2323
Default: Disabled
2424

doc/azure_ci.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,14 @@ We provide two fully baked configuration ready to be used on your projects:
3939
- [azure-windows-template.yml](https://raw.githubusercontent.com/commercialhaskell/stack/stable/doc/azure/azure-windows-template.yml)
4040
: Template for Azure Windows build
4141

42-
__NOTE__: It is likely going to be necessary to modify this configuration to
43-
match the needs of your project, such as tweaking the build matrix to alter
44-
which GHC versions you test against, or to specify GHC-version-specific
45-
`stack.yaml` files if necessary. Don't be surprised if it doesn't work the
46-
first time around. See the multiple GHC section below for more information.
42+
!!! note
43+
44+
It is likely going to be necessary to modify this configuration to match
45+
the needs of your project, such as tweaking the build matrix to alter
46+
which GHC versions you test against, or to specify GHC-version-specific
47+
`stack.yaml` files if necessary. Don't be surprised if it doesn't work the
48+
first time around. See the multiple GHC section below for more
49+
information.
4750

4851
## Creating Azure Pipelines
4952

doc/faq.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,9 +250,11 @@ Stack will automatically install build tools required by your packages or their
250250
dependencies, in particular [Alex](https://hackage.haskell.org/package/alex) and
251251
[Happy](https://hackage.haskell.org/package/happy).
252252

253-
__NOTE__: This works when using LTS or nightly resolvers, not with GHC or
254-
custom resolvers. You can manually install build tools by running, e.g.,
255-
`stack build alex happy`.
253+
!!! note
254+
255+
This works when using LTS or nightly resolvers, not with GHC or custom
256+
resolvers. You can manually install build tools by running, e.g.,
257+
`stack build alex happy`.
256258

257259
## How does Stack choose which snapshot to use when creating a new configuration file?
258260

doc/maintainers/team_process.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ etc) that amounts to about one or two hours spent per week being on-call.
8484
Again, these estimates will evolve over time as we settle into an optimal
8585
process, but for now we anticipate growing the team to about eight members
8686
(which is the size of the `Stackage` team as well), each of whom is likely to
87-
spend about two hours in total on upkeep work every eight weeks.
87+
spend about two hours in total on upkeep work every eight weeks.
8888

8989

9090
## Issue and pull request interaction guidelines
@@ -138,7 +138,7 @@ question. If you're not sure who's best to consult you should ask on
138138

139139
Try to be clear to the requester that you're opening the discussion up to more
140140
participants and that the proposal will require thoughtful consideration
141-
(probably a majority vote) before any decision is made.
141+
(probably a majority vote) before any decision is made.
142142

143143
Also remember that busy schedules, lack of complete familiarity with a given
144144
subject, strong-yet-opposing opinions held by equally rational people, and many
@@ -150,7 +150,7 @@ on-track and concrete.
150150
respectful "no".*
151151

152152
*If feasible, propose alternative solutions or educate the user in preference to
153-
complicating `Stack` or accepting scope-creep.*
153+
complicating `Stack` or accepting scope-creep.*
154154

155155
With respect to assessing a PR's code, @snoyberg has outlined some
156156
[tips for successfully getting one's work merged
@@ -205,11 +205,13 @@ When closing an issue, please provide a brief explanation for why the issue was
205205
closed, such as a reference to a PR, a comment about lack of clarification,
206206
etc.
207207

208-
__NOTE__ The following sections establish rules under which a bug report will
209-
be closed by the maintainer team. The goal is to avoid a situation where issues
210-
linger in an indeterminate state. The maintainer team is allowed to disregard
211-
these "rules" at any point. In other words: the goal isn't to allow people to
212-
"lawyer" issues.
208+
!!! note
209+
210+
The following sections establish rules under which a bug report will be
211+
closed by the maintainer team. The goal is to avoid a situation where issues
212+
linger in an indeterminate state. The maintainer team is allowed to
213+
disregard these "rules" at any point. In other words: the goal isn't to
214+
allow people to "lawyer" issues.
213215

214216
### Discussion
215217

doc/nix_integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Nix integration
44

5-
(since 0.1.10.0)
5+
[:octicons-tag-24: 0.1.10.0](https://github.com/commercialhaskell/stack/releases/tag/v0.1.10.0)
66

77
[Nix](https://nixos.org/) is a purely functional package manager. Stack can be
88
configured to integrate with Nix.

doc/travis_ci.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,13 @@ ready to be used on your projects:
1818
and macOS. The configuration is significantly more involved to allow
1919
for all of this branching behavior.
2020

21-
__NOTE__: It is likely going to be necessary to modify this configuration to
22-
match the needs of your project, such as tweaking the build matrix to alter
23-
which GHC versions you test against, or to specify GHC-version-specific
24-
`stack.yaml` files if necessary. Don't be surprised if it doesn't work the
25-
first time around. See the multiple GHC section below for more information.
21+
!!! note
22+
It is likely going to be necessary to modify this configuration to match
23+
the needs of your project, such as tweaking the build matrix to alter
24+
which GHC versions you test against, or to specify GHC-version-specific
25+
`stack.yaml` files if necessary. Don't be surprised if it doesn't work
26+
the first time around. See the multiple GHC section below for more
27+
information.
2628

2729
Each of these configurations is ready to be used immediately, just
2830
copy-paste the content into the `.travis.yml` file in the root or your

0 commit comments

Comments
 (0)