Skip to content

Commit

Permalink
smaller doc updates after release.
Browse files Browse the repository at this point in the history
  • Loading branch information
matthid committed Jun 10, 2018
1 parent ce3dac1 commit 91a195d
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 17 deletions.
2 changes: 1 addition & 1 deletion RELEASE_NOTES.md
Expand Up @@ -12,7 +12,7 @@
## 5.0.0 - 2018-06-06

* Deep integration into the .NET SDK and .Net Core
* Global dotnet cli-tool `dotnet tool install fake-cli -g --version 5.0.0-*`
* Global dotnet cli-tool `dotnet tool install fake-cli -g --version 5.*`
* `dotnet-fake` cli tool via `DotNetCliToolReference`
* Standalone `.zip` xcopy deployment and various package manager integrations (for example chocolatey).
* The old runner (`FAKE` nuget package) is obsolete
Expand Down
2 changes: 1 addition & 1 deletion build.proj
Expand Up @@ -6,7 +6,7 @@
</PropertyGroup>

<ItemGroup>
<DotNetCliToolReference Include="dotnet-fake" Version="5.0.0-*" />
<DotNetCliToolReference Include="dotnet-fake" Version="5.*" />
</ItemGroup>

<Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk" />
Expand Down
18 changes: 5 additions & 13 deletions help/markdown/fake-fake5-learn-more.md
@@ -1,6 +1,6 @@
# FAKE 5 - Learn more

> This is especially about the FAKE 5 update, [here you can learn about FAKE](fake-what-is-fake.html)
> This is especially about the FAKE 5 update, [here you can learn about FAKE](fake-what-is-fake.html) or learn [how to contribute](contributing.html)
FAKE 5 is a huge undertaking in modularizing and porting FAKE 4 to dotnet-core.
At the same time we want to use that opportunity to pay old API debts.
Expand All @@ -15,18 +15,11 @@ So before I go into the details of what changed and what the vision is going for
> Therefore I decided to make the finish line of FAKE 5 a community effort.
> If your favorite module is missing, please port it and send a PR (see Open Work section below).
## How stable is it? What is RC? Should I use it?
## How stable is it?

First, let me say that there are two distributions of FAKE 5.

* The first one is an update to the 'regular' FAKE 4 package on NuGet.
It's very safe to update to this package as mentioned in the [migrate to fake 5 guide](fake-migrate-to-fake-5.html).
Update the package and fix the `Obsolete` warnings to use the new API. There might still be some minor issues in the new API but it is considered stable now (ie no more breaking changes).
* The second one is the new dotnet-core version of FAKE.
This version is brand-new, was migrated to a new platform and has several API changes.
We call it the "new runner" it bundles the support for the `#r "paket: ..."` references and has a new [CLI](fake-commandline.html). At this point we no longer break the API but there might still be some minor issues.

> Fake 5 and this website are already released with Fake 5, so it might be more stable than you think.
We had quite a long alpha, beta and rc-phase so we are positive that it is ready.
There might be some missing modules as we have not 100% coverage of the old API.
If you are blocked by missing modules please consider porting it and sending a PR.

## Modules? Packages? Paket?

Expand All @@ -48,7 +41,6 @@ This section describes work that still need to be done to finally release FAKE 5
* Missing documentation
* Update documentation
* Fixing issues with the new website
* Implement a special formatting for the obsolete warnings -> parse them -> suggest new API dependencies file.

## New API-Design

Expand Down
2 changes: 1 addition & 1 deletion help/markdown/fake-gettingstarted.md
Expand Up @@ -43,7 +43,7 @@ There are various ways to install FAKE 5:
See the [template](fake-template.html) page for more information.

* Install the 'fake' or 'fake-netcore' package for you system (currenty chocolatey).
Example `choco install fake -pre`
Example `choco install fake`

* Use it as dotnet tool: Add `<DotNetCliToolReference Include="dotnet-fake" Version="5.*" />` to your dependencies and run `dotnet fake ...` instead of `fake ...`, see [this example](https://github.com/FakeBuild/fake-bootstrap/blob/master/dotnet-fake.csproj)

Expand Down
2 changes: 1 addition & 1 deletion help/templates/indexpage.cshtml
Expand Up @@ -13,7 +13,7 @@
<h2><strong>F# Make 5</strong> - A DSL for build tasks and more
<br />
The power of F# - anywhere - anytime</h2>
<p>While FAKE 5 is already usable, a lot of work still has to be done ... PLEASE HELP
<p>FAKE 5 is stable, but as a community project we always have work to do ... PLEASE HELP
</p>
<a href="fake-fake5-learn-more.html" class="button big icon fa-check-circle">Learn more</a>
</div>
Expand Down

0 comments on commit 91a195d

Please sign in to comment.