Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation around version strategies #4220

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Improve documentation around version strategies #4220

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9926123
Improve listing of version strategies in how-it-works.md
selfdocumentingcode Sep 21, 2024
5cd8b00
Fix Edit Diagram link on how-it-works.md
selfdocumentingcode Sep 21, 2024
c733fbb
Use correct target name in docs build instructions readme
selfdocumentingcode Sep 21, 2024
0d36695
Replace TrunkBased strategy listing with Mainline
selfdocumentingcode Sep 23, 2024
c3bf45b
Update description of Mainline strategy in how-it-works
selfdocumentingcode Sep 23, 2024
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
10 changes: 5 additions & 5 deletions docs/readme.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

can you also include the details for MarkdownSnippets that converts the *.source.md into *.md files in this readme?
This tool is used to embed some files into md files

https://github.com/GitTools/GitVersion/blob/main/.github/workflows/mkdocs.yml#L24-L28

Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To serve up the documentation locally, you need to run the following
commands:

```shell
./build.ps1 -Stage build -Target PrepareBuild
./build.ps1 -Stage build -Target BuildPrepare
./build.ps1 -Stage build -Target Build
./build.ps1 -Stage docs -Target PreviewDocs
```
Expand All @@ -32,7 +32,7 @@ On Windows, you need to run the following commands in a PowerShell
terminal:

```shell
./build.ps1 -Stage build -Target PrepareBuild
./build.ps1 -Stage build -Target BuildPrepare
./build.ps1 -Stage build -Target Build
./build.ps1 -Stage docs -Target PreviewDocs
```
Expand All @@ -43,14 +43,14 @@ First you need to [install PowerShell on macOS][ps-mac] or [Linux][ps-linux],
then execute the following commands:

```shell
./build.ps1 -Stage build -Target PrepareBuild
./build.ps1 -Stage build -Target BuildPrepare
./build.ps1 -Stage build -Target Build
./build.ps1 -Stage docs -Target PreviewDocs
```

After pressing enter, the documentation will be generated and then served under
a local web server. Information about the URL that can be used to view the docs
will be shown in the output. Copy/paste this URL into a browser window.
a local web server. Information about the URL that can be used to view the docs
will be shown in the output. Copy/paste this URL into a browser window.

[gitversion.net]: https://gitversion.net/
[forking]: https://guides.github.com/activities/forking/
Expand Down