diff --git a/docs/input/docs/commands/export.md b/docs/input/docs/commands/export.md index a79be203..cfd1158c 100644 --- a/docs/input/docs/commands/export.md +++ b/docs/input/docs/commands/export.md @@ -5,7 +5,7 @@ Title: Export This command will export all the release notes for a given repository on GitHub. The generated file will be in Markdown format, and the contents of the exported -file is configurable using the GitReleaseManager.yaml file, per repository. +file is configurable using the GitReleaseManager configuration file, per repository. There are two modes of operation when exporting Release Notes. GitReleaseManager can either export all Release Notes, or can export only a specific Release, diff --git a/docs/input/docs/commands/init.md b/docs/input/docs/commands/init.md index 16442f36..26eeac45 100644 --- a/docs/input/docs/commands/init.md +++ b/docs/input/docs/commands/init.md @@ -3,8 +3,8 @@ Order: 80 Title: Init --- -The Init command is used to create GitReleaseManager.yaml which controls the -configurable options of GitReleaseManager +The Init command is used to create a GitReleaseManager configuration file which +controls the configurable options of GitReleaseManager ## **Optional Parameters** @@ -15,13 +15,13 @@ configurable options of GitReleaseManager ## **Examples** -Create a new GitReleaseManager.yaml file in the current working directory: +Create a new GitReleaseManager configuration file in the current working directory: ```bash gitreleasemanager.exe init ``` -Create a new GitReleaseManager.yaml file in a specific directory: +Create a new GitReleaseManager configuration file in a specific directory: ```bash gitreleasemanager.exe init -d c:\temp diff --git a/docs/input/docs/configuration/create-configuration.md b/docs/input/docs/configuration/create-configuration.md index d9685384..9a7b897d 100644 --- a/docs/input/docs/configuration/create-configuration.md +++ b/docs/input/docs/configuration/create-configuration.md @@ -4,7 +4,7 @@ Title: Example of Create Configuration --- When creating a release, it is possible to control the look and feel of the -release notes, using settings within the GitReleaseManager.yaml file. +release notes, using settings within the GitReleaseManager configuration file. Out of the box, GitReleaseManager creates a simple list of Issues included within a milestone, split into the labels that have been configured. However, @@ -12,7 +12,7 @@ it is possible to include additional information in the form of a footer, which provides additional information, for example, where an installation of the release can be located. -Take for example the GitReleaseManager.yaml file which is used by the +Take for example the GitReleaseManager configuration file which is used by the [Chocolatey GUI](https://github.com/chocolatey/ChocolateyGUI) project: ```yaml diff --git a/docs/input/docs/configuration/default-configuration.md b/docs/input/docs/configuration/default-configuration.md index 18237107..c389a652 100644 --- a/docs/input/docs/configuration/default-configuration.md +++ b/docs/input/docs/configuration/default-configuration.md @@ -4,7 +4,7 @@ Title: Default Configuration RedirectFrom: docs/yaml/index.html --- -GitReleaseManager configuration can be controlled using a GitReleaseManager.yaml +GitReleaseManager configuration can be controlled using a configuration file, which is typically stored at the root of your project. GitReleaseManager ships with the following default set of configuration (i.e. @@ -68,7 +68,7 @@ labels: color: cc317c issue-labels-include: - Breaking Change - - Bug + - Bug - Documentation - Feature - Good First Issue @@ -108,11 +108,11 @@ control the look and feel of the generated release notes. milestone, which should be replaced with the actual milestone value. As an example, let's say you want to provide a link to where you can download your release, and the URL could be something like - . You don't want to have to hard code the - milestone number into your yaml configuration, so instead, you can use a - replacement string in your footer-content, which will then be replaced with - the actual milestone release number, when the release is created. Default is - false. + . You don't want to have to hard code + the milestone number into your yaml configuration, so instead, you can use + a replacement string in your footer-content, which will then be replaced + with the actual milestone release number, when the release is created. Default + is false. - **milestone-replace-text** - 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 diff --git a/docs/input/docs/configuration/exclude-issues.md b/docs/input/docs/configuration/exclude-issues.md index c909801b..99172a6c 100644 --- a/docs/input/docs/configuration/exclude-issues.md +++ b/docs/input/docs/configuration/exclude-issues.md @@ -27,6 +27,6 @@ will NOT be included within the generated release notes. :::{.alert .alert-warning} All issues assigned to a milestone have to have a label which matches to one -listed in the include to exclude sections of the GitReleaseManager.yaml file or -the default configuration. +listed in the include to exclude sections of the GitReleaseManager configuration +file or the default configuration. ::: diff --git a/docs/input/docs/configuration/export-configuration.md b/docs/input/docs/configuration/export-configuration.md index 4da486f3..db61906a 100644 --- a/docs/input/docs/configuration/export-configuration.md +++ b/docs/input/docs/configuration/export-configuration.md @@ -13,7 +13,7 @@ Out of the box, GitReleaseManager exports all the release notes for a given project, exactly as these release notes appear within GitHub. However, there are certain things that you might want to add, or remove, for the exported file. -Take for example the GitReleaseManager.yaml file which is used by the +Take for example the GitReleaseManager configuration file which is used by the [Chocolatey GUI](https://github.com/chocolatey/ChocolateyGUI) project: ```yaml diff --git a/docs/input/docs/configuration/include-issues.md b/docs/input/docs/configuration/include-issues.md index 3c25bb11..5000384f 100644 --- a/docs/input/docs/configuration/include-issues.md +++ b/docs/input/docs/configuration/include-issues.md @@ -25,6 +25,6 @@ will be included within the generated release notes. :::{.alert .alert-warning} All issues assigned to a milestone have to have a label which matches to one -listed in the include to exclude sections of the GitReleaseManager.yaml file or -the default configuration. +listed in the include to exclude sections of the GitReleaseManager configuration +file or the default configuration. :::