Skip to content

Commit 405b8bb

Browse files
gep13arturcic
authored andcommitted
(GH-1932) Add info, warning and danger callouts
1 parent 3fee455 commit 405b8bb

File tree

8 files changed

+51
-11
lines changed

8 files changed

+51
-11
lines changed

docs/input/docs/build-server-support/build-server/azure-devops.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,16 @@ to configure.
135135

136136
If GitVersion does not find any substitutions it will just default to using `FullSemVer`
137137

138-
**IMPORTANT:** If you currently use `$(rev:.r)` in your build number, that won't
138+
:::{.alert .alert-danger}
139+
**Important**
140+
141+
If you currently use `$(rev:.r)` in your build number, that won't
139142
work correctly if you
140143
use GitVersion variables as well due to the delayed expansion of the GitVersion
141144
vars. Instead, you might be able to use `$(GitVersion_BuildMetaData)` to achieve
142145
a similar result. See [Variables](../../more-info/variables) for more info on the
143146
variables.
147+
:::
144148

145149
#### Known limitations
146150

docs/input/docs/build-server-support/build-server/myget.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,15 @@ generated by GitVersion and apply this [MyGet Environment Variable](http://docs.
1919
wherever it is used during the build process.
2020
* Ensure the build script has been pushed to your source repository root. Done :)
2121

22-
Note: If you require the `AssemblyInfo.cs` files in your project to be patched
22+
:::{.alert .alert-info}
23+
**Note**
24+
25+
If you require the `AssemblyInfo.cs` files in your project to be patched
2326
with the information from GitVersion, you will have to run it manually, for
2427
example using the command:
2528

2629
`call %GitVersion% /updateassemblyinfo true`.
30+
:::
2731

2832
Also check [docs.myget.org](http://docs.myget.org/docs/reference/build-services#GitVersion_and_Semantic_Versioning)
2933
for the latest full info.

docs/input/docs/configuration.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,12 @@ working directory. It can be the root repository directory or any subdirectory
1616
in case you have a single repository for more than one project or are restricted
1717
to commit into a subdirectory.
1818

19-
**Note:** GitVersion ships with internal default configuration which works with
19+
:::{.alert .alert-info}
20+
**Note**
21+
22+
GitVersion ships with internal default configuration which works with
2023
GitHubFlow and GitFlow, probably with others too.
24+
:::
2125

2226
The *develop* branch is set to `ContinuousDeployment` mode by default as we have
2327
found that is generally what is needed when using GitFlow.
@@ -246,7 +250,11 @@ Custom merge message formats are evaluated _before_ any built in formats.
246250

247251
Then we have branch specific configuration, which looks something like this:
248252

249-
**NOTE: ** v4 changed from using regexes for keys, to named configs
253+
:::{.alert .alert-info}
254+
**Note**
255+
256+
v4 changed from using regexes for keys, to named configs
257+
:::
250258

251259
If you have branch specific configuration upgrading to v4 will force you to
252260
upgrade.

docs/input/docs/faq.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,13 @@ way.
4141
So `1.0.1-rc.1+5` would become `1.0.1-rc0001`, this takes into account
4242
characters which are not allowed and NuGets crap sorting.
4343

44-
**note: ** The `NuGetVersion` variable is floating, so when NuGet 3.0 comes out
44+
:::{.alert .alert-info}
45+
**Note**
46+
47+
The `NuGetVersion` variable is floating, so when NuGet 3.0 comes out
4548
with proper SemVer support GitVersion will switch this variable to a proper
4649
SemVer.
50+
:::
4751

4852
If you want to fix the version, use `NuGetVersionV2` which will stay the same
4953
after NuGet 3.0 comes out

docs/input/docs/reference/versioning-modes/mainline-development.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,15 @@ Here is an example of what mainline development looks like:
4343

4444
![Mainline mode](../../img/mainline-mode.png)
4545

46-
**WARNING:** This approach can slow down over time, we recommend to tag
46+
:::{.alert .alert-warning}
47+
**Warning**
48+
49+
This approach can slow down over time, we recommend to tag
4750
intermittently (maybe for minor or major releases) because then GitVersion
4851
will start the version calculation from that point. Much like a snapshot in an
4952
event sourced system. We will probably add in warnings to tag when things are
5053
slowing down.
54+
:::
5155

5256
## Usage
5357
By default GitVersion is set up to do [Continuous Delivery](continuous-delivery)

docs/input/docs/usage/command-line.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@ If you want a command line version installed on your machine then you can use
77
[Chocolatey](http://chocolatey.org) or [Homebrew](https://brew.sh/) to install
88
GitVersion.
99

10-
> **Hint**: While documentation and help use '/' as command prefix the hyphen '-'
10+
:::{.alert .alert-info}
11+
**Hint**
12+
13+
While documentation and help use '/' as command prefix the hyphen '-'
1114
is supported as well and is a better alternative for usage on \*nix systems.
1215
Example: *-output json vs. /output json*
16+
:::
1317

1418
## Chocolatey
1519

docs/input/docs/usage/gem.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,12 @@ Title: Gem
55

66
Just a gem wrapper around the command line to make it easier to consume from Rake.
77

8-
**NOTE** This is currently not being pushed.. Please get in touch if you are
9-
using this
8+
:::{.alert .alert-info}
9+
**Note**
10+
11+
This is currently not being pushed. Please get in touch if you are
12+
using this.
13+
:::
1014

1115
If you want a Ruby gem version installed on your machine then you can use
1216
[Bundler](http://bundler.io/) or [Gem](http://rubygems.org/) to install the
@@ -45,5 +49,9 @@ include GitVersion
4549
puts git_version('C:/read/info/from/another/repository').sha
4650
```
4751

48-
**Note:** Mono is not currently supported due to downstream dependencies on
52+
:::{.alert .alert-info}
53+
**Note**
54+
55+
Mono is not currently supported due to downstream dependencies on
4956
libgit2. The Gem can only be used with the .NET framework
57+
:::

docs/input/docs/usage/nuget-library.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ Title: NuGet Library
55

66
To use GitVersion from your own code.
77

8-
**Warning, we are not semantically versioning this library and it should be considered unstable.**
8+
:::{.alert .alert-warning}
9+
**Warning**
10+
11+
We are not semantically versioning this library and it should be considered unstable.**
12+
:::
913

1014
It also is not currently documented. Please open an issue if you are consuming
1115
the library to let us know, and why you need to.

0 commit comments

Comments
 (0)