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

Refresh website #2599

merged 33 commits into from
Feb 22, 2021

Conversation

asbjornu
Copy link
Member

@asbjornu asbjornu commented Feb 20, 2021

Description

This PR refreshes the website to match the logo created by @LazaroOnline in #2508. It also updates the documentation so it resolves #2326.

Related Issue

Motivation and Context

The documentation was chaotic and outdated. This PR does not complete that work, but it improves it a whole lot.

How Has This Been Tested?

  • I've made the arguments documentation shared between command line and the docs.
  • I've added HTMLProofer tests that verify links in the generated documentation.

Screenshots (if appropriate):

front page

usage

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Split the CLI documentation into four parts:

1. Installation
2. Arguments
3. Output
4. Assembly Patching

Also move the argument documentation from HelpWriter and into arguments.md.
1. Add a GitHub Actions workflow for validating the documentation.
2. Add A `Build-Documentation` Cake task to only build (not publish) the documentation.
@asbjornu
Copy link
Member Author

I'm having some Cake problems:

Cake Setup
   at Cake.Core.Tooling.Tool`1.Run(TSettings settings, ProcessArgumentBuilder arguments, ProcessSettings processSettings, Action`1 postAction) in C:\projects\cake\src\Cake.Core\Tooling\Tool.cs:line 103
   at Cake.Common.Tools.GitVersion.GitVersionRunner.Run(GitVersionSettings settings) in C:\projects\cake\src\Cake.Common\Tools\GitVersion\GitVersionRunner.cs:line 59
   at Cake.Common.Tools.GitVersion.GitVersionAliases.GitVersion(ICakeContext context, GitVersionSettings settings) in C:\projects\cake\src\Cake.Common\Tools\GitVersion\GitVersionAliases.cs:line 121
   at Submission#0.GitVersion(GitVersionSettings settings)
   at Submission#0.GetVersion(BuildParameters parameters)
   at Submission#0.<>c__DisplayClass0_6.<<Initialize>>b__114()
	Message:	GitVersion: Process returned an error (exit code 1).
	Data:	[  ]
	InnerException:	
	HelpLink:	
	Source:	Cake.Core
	HResult:	-2146233088

And:

Teardown error: System.NullReferenceException: Object reference not set to an instance of an object.
   at Cake.Core.CakeDataService.Get[TData]() in C:\projects\cake\src\Cake.Core\CakeDataService.cs:line 36
   at Cake.Core.CakeEngineActions.<>c__DisplayClass21_0`1.<RegisterTeardown>b__0(ITeardownContext context) in C:\projects\cake\src\Cake.Core\CakeEngineActions.cs:line 64
   at Cake.Core.DefaultExecutionStrategy.PerformTeardown(Action`1 action, ITeardownContext teardownContext) in C:\projects\cake\src\Cake.Core\DefaultExecutionStrategy.cs:line 57
   at Cake.Core.CakeEngine.PerformTeardown(IExecutionStrategy strategy, ICakeContext context, Stopwatch stopWatch, CakeReport report, Boolean exceptionWasThrown, Exception thrownException) in C:\projects\cake\src\Cake.Core\CakeEngine.cs:line 436

Ideas, @gep13, @arturcic?

@gep13
Copy link
Member

gep13 commented Feb 21, 2021

@asbjornu what command are you running when you get this error?

@arturcic
Copy link
Member

@gep13 ./build.ps1 -Target Build-Documentation

@gep13
Copy link
Member

gep13 commented Feb 21, 2021

Ah gotcha, you mean this error is coming up when running the new docs workflow? On phone, so hard to view that.

Could it be due to not everything being checked up? In the build.hmm there is an additional checkout step, which is likely required to fully assert version number.

Arguably this isn't needed for a docs build, so could be that we make that part of the Setup task conditional?

@asbjornu
Copy link
Member Author

Arguably this isn't needed for a docs build, so could be that we make that part of the Setup task conditional?

Good point, @gep13. If I only knew where Task("Setup") was defined… 😅

@gep13
Copy link
Member

gep13 commented Feb 22, 2021

@asbjornu this isn't a Task, but rather a setup method:

https://github.com/gittools/gitversion/blob/main/build.cake#L55

@asbjornu
Copy link
Member Author

Gotcha @gep13. Thanks!

@asbjornu asbjornu marked this pull request as ready for review February 22, 2021 16:23
docs/input/docs/usage/cli/arguments.md Outdated Show resolved Hide resolved
@arturcic
Copy link
Member

@asbjornu look really great the new UI, really fresh. I had a quick review, there is one comment I added but overall looks good. I think we can merge it as it is now, later we can/need to improve with follow up PRs

@asbjornu asbjornu merged commit a4927d6 into GitTools:main Feb 22, 2021
@asbjornu asbjornu deleted the feature/website-refresh branch February 22, 2021 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment