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

Fix chocolatey docs and some links in footer #1584

Merged
merged 1 commit into from
Jun 11, 2017
Merged

Fix chocolatey docs and some links in footer #1584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 11 additions & 8 deletions help/markdown/windows-chocolatey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# Using Chocolatey

**Note: This documentation is for FAKE.exe before version 5 (or the non-netcore version). The documentation needs te be updated, please help! **
## Namespace

To be used, the `Choco` module needs the `Fale.Windows` namespace:
Copy link
Member

Choose a reason for hiding this comment

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

typo


open Fake.Windows

## Install

The [`Install`](apidocs/fake-choco.html) method allow to easily install packages from [Chocolatey](https://chocolatey.org).
The [`Install`](apidocs/fake-choco.html) method allow to easily install packages from [Chocolatey](https://chocolatey.org).
By default all user interaction are skipped but it can be modified through the `NonInteractive` property.


Expand All @@ -23,8 +26,8 @@ It is based on [`NuGet`](create-nuget-package.html) but have some specifics, the
It is also possible to only defines the fields in ChocoPackParams and the corresponding files will be created.

Target "ChocoPack" (fun _ ->
Choco.Pack (fun p ->
{ p with
Choco.Pack (fun p ->
{ p with
PackageId = "nvika"
Version = version
Title = "NVika"
Expand Down Expand Up @@ -56,7 +59,7 @@ Placeholder | replaced by (`ChocoPackParams` record field)
`@packageSourceUrl@` | `PackageSourceUrl`: Url to the chocolatey package repository, not the software (unless they are the same).

### chocolateyInstall.ps1
To use a chocolateyInstall.ps1 template, a file with the same name must exists in a `tool` folder alongside the .nuspec template file.
To use a chocolateyInstall.ps1 template, a file with the same name must exists in a `tool` folder alongside the .nuspec template file.
If it doesn't exists but at least `Title` and `PackageDownloadUrl` are defined, the chocolateyInstall.ps1 will be created

Placeholder | replaced by (`ChocoPackParams` record field)
Expand All @@ -73,7 +76,7 @@ Placeholder | replaced by (`ChocoPackParams` record field)
`@checksum64Type@` | `Checksum64Type`: The type of checksum that the file is validated with. Default: Sha256.

### chocolateyUninstall.ps1
To use a chocolateyUninstall.ps1 template, a file with the same name must exists in a `tool` folder alongside the .nuspec template file.
To use a chocolateyUninstall.ps1 template, a file with the same name must exists in a `tool` folder alongside the .nuspec template file.
If it doesn't exists but at least `Title` and `UninstallPath` are defined, the chocolateyUninstall.ps1 will be created

Placeholder | replaced by (`ChocoPackParams` record field)
Expand All @@ -85,8 +88,8 @@ Placeholder | replaced by (`ChocoPackParams` record field)

## Push

The [`Push`](apidocs/fake-choco.html) method allow to push a package (.nupkg) to Chocolatey.
If need the source could be modified to a private feed for example.
The [`Push`](apidocs/fake-choco.html) method allow to push a package (.nupkg) to Chocolatey.
If need the source could be modified to a private feed for example.
It is heavily recommended to indicate your Chocolatey api key, specifically for the build servers which don't have registered Chocolatey api key.
In order to keep it secret you can encrypt it, for example with |AppVeyor](https://www.appveyor.com) you can [encrypt an environment variable](https://www.appveyor.com/docs/build-configuration#secure-variables) and use it in your FAKE script:

Expand Down
21 changes: 10 additions & 11 deletions help/templates/template.cshtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE HTML>
<!DOCTYPE HTML>
@{
var prefix = string.IsNullOrEmpty(ViewBag.PathPrefix) ? "" : ViewBag.PathPrefix;
bool? hasBanner = ViewBag.HasBanner;
Expand Down Expand Up @@ -171,9 +171,8 @@
<section>
<h2>Important Links</h2>
<ul class="divided">
<li><a href="@(prefix)404.html">Quickstart</a></li>
<li><a href="@(prefix)404.html">Installation</a></li>
<li><a href="@(prefix)404.html">Modules</a></li>
<li><a href="https://fake.build/fake-gettingstarted.html">Getting started</a></li>
<li><a href="https://fake.build/fake-fake5-modules.html">Modules</a></li>
Copy link
Member

Choose a reason for hiding this comment

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

We need to use @(prefix) here, otherwise it doesn't work locally or on on other urls.

No worries I'll update it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, sorry, I wasn't paying enough attention.

<li><a href="@(prefix)404.html">FAKE Header</a></li>
<li><a href="@(prefix)404.html">Git</a></li>
</ul>
Expand All @@ -186,12 +185,12 @@
<section>
<h2>Further projects</h2>
<ul class="divided">
<li><a href="@(prefix)404.html">Paket</a></li>
<li><a href="@(prefix)404.html">FSharp Formatting</a></li>
<li><a href="@(prefix)404.html">F#</a></li>
<li><a href="@(prefix)404.html">Ionide</a></li>
<li><a href="@(prefix)404.html">Forge</a></li>
<li><a href="@(prefix)404.html">FSharp.Compiler.Service</a></li>
<li><a href="https://fsprojects.github.io/Paket/">Paket</a></li>
<li><a href="https://fsprojects.github.io/FSharp.Formatting/">FSharp Formatting</a></li>
<li><a href="http://fsharp.org/">F#</a></li>
<li><a href="http://ionide.io/">Ionide</a></li>
<li><a href="http://forge.run/">Forge</a></li>
<li><a href="https://fsharp.github.io/FSharp.Compiler.Service/">FSharp.Compiler.Service</a></li>
</ul>
</section>

Expand Down Expand Up @@ -271,7 +270,7 @@
<!--<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/js/bootstrap.min.js"></script>-->
<script src="@(prefix)assets/js/tips.js" type="text/javascript"></script>
<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>

<script src="@(prefix)assets/js/jquery.min.js"></script>
<script src="@(prefix)assets/js/jquery.dropotron.min.js"></script>
<script src="@(prefix)assets/js/skel.min.js"></script>
Expand Down