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.

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

Refresh website #2599

Merged
merged 33 commits into from
Feb 22, 2021
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
b3fc376
Refresh website
asbjornu Feb 2, 2021
0a81d69
Rework the entire documentation into three main sections
asbjornu Feb 12, 2021
a8e2956
Add some descriptions
asbjornu Feb 19, 2021
a4cf2a4
Rejig the build server documentation
asbjornu Feb 19, 2021
2d79a5f
Fix build server titles and descriptions
asbjornu Feb 19, 2021
d6b2bb9
Clean up the versioning modes section
asbjornu Feb 19, 2021
f06af23
Improve version variable documentation
asbjornu Feb 19, 2021
b81f607
Simplify usage section
asbjornu Feb 20, 2021
d08cbaa
Update usage information
asbjornu Feb 20, 2021
2feda30
Update path to configuration.md in test
asbjornu Feb 20, 2021
32d5c92
Update path to variables.md in test
asbjornu Feb 20, 2021
7b20956
Rename cli.md to arguments.md
asbjornu Feb 21, 2021
427f2a5
Split the CLI documentation into four parts
asbjornu Feb 21, 2021
68f0d33
Add GitHub Action for validating the documentation
asbjornu Feb 21, 2021
21c0b80
Ignore /api/ when validating the documentation
asbjornu Feb 21, 2021
0b56d75
Rename docs workflow
asbjornu Feb 21, 2021
0adb298
Allow hash hrefs in documentation
asbjornu Feb 21, 2021
24a613d
Fix HelpWriter substring index bug
asbjornu Feb 21, 2021
edec46c
Set fetch-depth to 0
asbjornu Feb 22, 2021
2b8b448
Assume extensions
asbjornu Feb 22, 2021
d260185
Disable external URL check
asbjornu Feb 22, 2021
816c212
Add requirements to resolve #2194
asbjornu Feb 22, 2021
eedba52
Reorganize the branching strategies section
asbjornu Feb 22, 2021
5de376f
Merge "incrementing per commit" into "version increments"
asbjornu Feb 22, 2021
7885c4f
Move version sources and increments to reference
asbjornu Feb 22, 2021
1ba17b8
Rename "versioning modes" to just "modes" and "mainline development" …
asbjornu Feb 22, 2021
3518516
Move all docs images into the docs/img directory
asbjornu Feb 22, 2021
5ee7370
Merge examples into branching strategies index
asbjornu Feb 22, 2021
d76a51a
Rename "create/update examples" to "contribute examples"
asbjornu Feb 22, 2021
52387f6
Fix links
asbjornu Feb 22, 2021
0ff84a1
Clarify ignore config to resolve #2334
asbjornu Feb 22, 2021
6823d85
Add OS support information to resolve #2365
asbjornu Feb 22, 2021
3607803
Remove outdated arguments
asbjornu Feb 22, 2021
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
22 changes: 22 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Verify Documentation

on: [push, pull_request]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0

- name: '[Build Documentation]'
shell: pwsh
run: ./build.ps1 -Target Build-Documentation

- name: '[HTMLProofer]'
uses: chabad360/htmlproofer@master
with:
directory: ./artifacts/Documentation
arguments: --url-ignore /api/ --allow-hash-href --assume-extension --disable-external
2 changes: 1 addition & 1 deletion BREAKING_CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ work for you
`GitVersionConfig.yaml` instead
- GitVersionTask's `ReleaseDateAttribute` no longer exists

[gitflow]: https://gitversion.net/docs/git-branching-strategies/gitflow-examples_complete
[gitflow]: https://gitversion.net/docs/learn/branching-strategies/gitflow-examples_complete
[pr-1541]: https://github.com/GitTools/GitVersion/pull/1541
[pr-1581]: https://github.com/GitTools/GitVersion/pull/1581
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ We love contributions to get started contributing you might need:
- [Get started with git](http://rogerdudler.github.io/git-guide)
- [How to create a pull request](https://help.github.com/articles/using-pull-requests)
- [An issue to work on](https://github.com/GitTools/GitVersion/labels/up-for-grabs) - We are on [Up for grabs](http://up-for-grabs.net/), our up for grabs issues are tagged `up-for-grabs`
- An understanding of our [architecture](http://gitversion.readthedocs.org/en/latest/more-info/how-it-works/#architecture) and how [we write tests](#writing-tests)
- An understanding of our [architecture](http://gitversion.net/docs/learn/how-it-works#architecture) and how [we write tests](#writing-tests)

Once you know how to create a pull request and have an issue to work on, just post a comment saying you will work on it.
If you end up not being able to complete the task, please post another comment so others can pick it up.
Expand All @@ -23,7 +23,7 @@ Issues are also welcome, [failing tests](#writing-tests) are even more welcome.

## How it works

See [how it works](http://gitversion.readthedocs.org/en/latest/more-info/how-it-works/) in GitVersion's documentation
See [how it works](http://gitversion.net/docs/learn/how-it-works/) in GitVersion's documentation

## Writing Tests

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ from The Noun Project.
[contribute]: https://github.com/GitTools/GitVersion/blob/main/CONTRIBUTING.md
[why]: https://gitversion.net/docs/why
[usage]: https://gitversion.net/docs/usage/usage
[how]: https://gitversion.net/docs/more-info/how-it-works
[how]: https://gitversion.net/docs/learn/how-it-works
[faq]: https://gitversion.net/docs/faq
[who]: https://gitversion.net/docs/who
[gv-in-action]: https://raw.github.com/GitTools/GitVersion/master/docs/input/docs/img/README.png
Expand Down
7 changes: 6 additions & 1 deletion build/docs.cake
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Task("Preview-Documentation")
});
});

Task("Force-Publish-Documentation")
Task("Build-Documentation")
.IsDependentOn("Clean-Documentation")
.WithCriteria(() => DirectoryExists(MakeAbsolute(Directory("docs"))), "Wyam documentation directory is missing")
.Does<BuildParameters>((parameters) =>
Expand All @@ -37,7 +37,12 @@ Task("Force-Publish-Documentation")
ConfigurationFile = MakeAbsolute((FilePath)"config.wyam"),
Settings = parameters.WyamAdditionalSettings
});
});

Task("Force-Publish-Documentation")
.IsDependentOn("Build-Documentation")
.Does<BuildParameters>((parameters) =>
{
PublishDocumentation(parameters);
});

Expand Down
13 changes: 13 additions & 0 deletions docs/input/_Card.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<div class="card">
<div class="card-header">
<img src="/assets/img/@Model.String("CardIcon")" alt="" aria-hidden="true">
<h5>@Html.Raw(Model.String(Keys.Title))</h5>
</div>

<div class="card-body">
<p class="card-text">@Html.Raw(Model.String(DocsKeys.Description))</p>
<a href="/@Model.String(Keys.RelativeFilePathBase)" class="btn btn-primary">
@Html.Raw(Model.String(Keys.Title))
</a>
</div>
</div>
10 changes: 10 additions & 0 deletions docs/input/_Head.cshtml
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
<meta name="google" content="notranslate">
<meta http-equiv="Content-Language" content="en">
<meta name="google-site-verification" content="46g_yrsDyk5YTGoXb2ii9BjmTJ2QAEsacqn6wqiAiII" />
<meta property="og:image" content="https://github.com/GitTools/graphics/raw/master/GitVersion/banner-1280x640.png" />
<meta property="og:site_name" content="GitVersion" />
<meta property="og:type" content="object" />
<meta property="og:title" content="GitVersion" />
<meta property="og:url" content="https://gitversion.net/" />
<meta property="og:description" content="From git log to SemVer in no time" />
<link rel="icon" href="/assets/img/icon.png" type="image/png">
<link rel="icon" href="/assets/img/icon.svg" type="image/svg">
<link rel="apple-touch-icon" href="/assets/img/icon.png" type="image/png">
<link rel="apple-touch-icon" href="/assets/img/icon.svg" type="image/svg">
Binary file not shown.
Loading