Skip to content

Commit c061211

Browse files
authored
Merge pull request #94 from mderriey/fix-docs-links
(GH-93) fix internal links in docs
2 parents 8cacbe5 + e7af9a6 commit c061211

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

docs/configuration/create-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This would result in the following [release notes](https://github.com/chocolatey
2222
<div class="admonition note">
2323
<p class="first admonition-title">Note</p>
2424
<p class="last">
25-
The generated URL for the link to Chocolatey.org includes the milestone number. The complete URL is https://chocolatey.org/packages/chocolateyGUI/0.13.1. This was achieved by using a regular expression replacement of the [footer-content](doc:default-configuration), using the [milestone-replace-text](doc:default-configuration) property as the text to replace with the actual milestone.
25+
The generated URL for the link to Chocolatey.org includes the milestone number. The complete URL is https://chocolatey.org/packages/chocolateyGUI/0.13.1. This was achieved by using a regular expression replacement of the [footer-content](default-configuration.md), using the [milestone-replace-text](default-configuration.md) property as the text to replace with the actual milestone.
2626

2727
This approach can be used for any project, this example simply shows what is done in the ChocolateyGUI project.
2828
</p>

docs/configuration/default-configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ When creating a Release, there are a number of options which can be set to contr
4848
* **milestone-replace-text**
4949
* A string value which contains the string which should be replaced in the footer-content with the actual milestone release number. Default is an empty string.
5050

51-
See the [example create configuration section](doc:create-configuration) to see an example of how a footer can be configured.
51+
See the [example create configuration section](create-configuration.md) to see an example of how a footer can be configured.
5252

5353
## Export Options
5454

@@ -63,10 +63,10 @@ See the [example create configuration section](doc:create-configuration) to see
6363
* **multiline-regex**
6464
* A boolean value which indicates that the regular expression should span multiple lines. Default is false.
6565

66-
See the [example export configuration section](doc:export-configuration) to see an example of how the export can be configured.
66+
See the [example export configuration section](export-configuration.md) to see an example of how the export can be configured.
6767

6868
## Issues to include
69-
See the [Issues to include](doc:issues-to-include) section.
69+
See the [Issues to include](include-issues.md) section.
7070

7171
## Issues to exclude
72-
See the [Issues to exclude](doc:issues-to-exclude) section.
72+
See the [Issues to exclude](exclude-issues.md) section.

docs/why-grm.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Why would I want to use GitReleaseManager?
22

3-
There are a number of reasons that you would want to incorporate GitReleaseManager into your workflow.
3+
There are a number of reasons that you would want to incorporate GitReleaseManager into your workflow.
44

55
<div class="admonition note">
66
<p class="first admonition-title">Note</p>
@@ -13,11 +13,11 @@ Here are a few examples:
1313

1414
## Create Milestone Release Notes
1515

16-
Assuming that you are already using the concept of milestones in GitHub, once a milestone is completed, and you have a number of closed issues, you can use the [create command](doc:create) to generate a draft set of release notes, which includes all the closed issues (assuming that they match the [set of labels](doc:issues-to-include) which are configured to be included.
16+
Assuming that you are already using the concept of milestones in GitHub, once a milestone is completed, and you have a number of closed issues, you can use the [create command](commands/create.md) to generate a draft set of release notes, which includes all the closed issues (assuming that they match the [set of labels](configuration/include-issues.md) which are configured to be included.
1717

1818
## Publish Release
1919

20-
Even if you don't want to use GitReleaseManager to create the release notes on GitHub, you may still want the ability to Publish a Release (which has the result of creating a tag in your repository). This can be done using the [publish command](doc:publish).
20+
Even if you don't want to use GitReleaseManager to create the release notes on GitHub, you may still want the ability to Publish a Release (which has the result of creating a tag in your repository). This can be done using the [publish command](commands/publish.md).
2121

2222
<div class="admonition note">
2323
<p class="first admonition-title">Note</p>
@@ -28,12 +28,12 @@ Even if you don't want to use GitReleaseManager to create the release notes on G
2828

2929
## Add Asset to Release
3030

31-
As part of your Release process, you may want to include assets into the GitHub Release. This could be the final MSI package for your application, or a nuget package. GitReleaseManager allows you to do this in two ways. The first is using the [create command](doc:create), which includes the ability to add an asset at the time of Release creation. However, at the time of Release creation, you might not have all the assets that you want to add. As a result, there is a separate [add asset](doc:add-asset) command that you can use to add an asset to an existing Release.
31+
As part of your Release process, you may want to include assets into the GitHub Release. This could be the final MSI package for your application, or a nuget package. GitReleaseManager allows you to do this in two ways. The first is using the [create command](commands/create.md), which includes the ability to add an asset at the time of Release creation. However, at the time of Release creation, you might not have all the assets that you want to add. As a result, there is a separate [add asset](commands/add-assets.md) command that you can use to add an asset to an existing Release.
3232

3333
## Close Milestone
3434

35-
When working directly in GitHub, publishing a Release doesn't close the associated milestone. When using the GitReleaseManager's [publish command](doc:publish) the associated milestone is also closed. However, you can also use the [close command](doc:close] directly if you are not using the publish workflow as part of your process.
35+
When working directly in GitHub, publishing a Release doesn't close the associated milestone. When using the GitReleaseManager's [publish command](commands/publish.md) the associated milestone is also closed. However, you can also use the [close command](commands/doc:close] directly if you are not using the publish workflow as part of your process.
3636

3737
## Export Release Notes
3838

39-
When working on a project, you might want to include all the Release Notes within the application itself, let's say in the About dialog. GitReleaseManager's [export command](doc:export) makes it really simple to export the entire history of your application/product, by creating a markdown file with all the information contained in the releases section of GitHub.
39+
When working on a project, you might want to include all the Release Notes within the application itself, let's say in the About dialog. GitReleaseManager's [export command](commands/export.md) makes it really simple to export the entire history of your application/product, by creating a markdown file with all the information contained in the releases section of GitHub.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
site_name: GitReleaseManager
22
theme: readthedocs
33
repo_url: https://github.com/GitTools/GitReleaseManager
4+
strict: true
45

56
pages:
67
- What is GitReleaseManager: index.md

0 commit comments

Comments
 (0)