Skip to content
This repository was archived by the owner on Mar 1, 2021. It is now read-only.

Commit a70b436

Browse files
committed
(doc) Added some basic documentation
1 parent 33db50c commit a70b436

File tree

12 files changed

+324
-0
lines changed

12 files changed

+324
-0
lines changed

docs/input/assets/css/override.css

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
/* Control the margin for bootstrap alert boxes */
2+
.alert > p {
3+
margin-top: 0px;
4+
}
5+
6+
/* Control the look and feel of the copy box applied to code sections */
7+
.btn-copy[disabled] .clippy {
8+
opacity: .3;
9+
}
10+
pre .btn-copy {
11+
-webkit-transition: opacity 0.3s ease-in-out;
12+
-o-transition: opacity 0.3s ease-in-out;
13+
transition: opacity 0.3s ease-in-out;
14+
opacity: 0;
15+
padding: 2px 6px;
16+
float: right;
17+
}
18+
pre:hover .btn-copy {
19+
opacity: 1;
20+
}
Lines changed: 3 additions & 0 deletions
Loading

docs/input/assets/js/anchor.min.js

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/input/assets/js/clipboard.min.js

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/input/docs/index.cshtml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
Title: Documentation
3+
---
4+
<p>This user guide, like Cake.DotNetTool.Module itself, is under very active development. Some parts of it aren't
5+
documented as completely as they need to be, but we gladly accept your contributions.</p>
6+
7+
<p>We need your help to improve the documentation for Cake.DotNetTool.Module, so if there is something that you
8+
would like to add then you can edit the content directly on GitHub.</p>
9+
10+
@foreach(IDocument child in Model.DocumentList(Keys.Children).OrderBy(x => x.Get<int>(DocsKeys.Order, 1000)))
11+
{
12+
<h1>@(child.String(Keys.Title))</h1>
13+
if(child.ContainsKey(DocsKeys.Description))
14+
{
15+
<p>@Html.Raw(child.String(DocsKeys.Description))</p>
16+
}
17+
18+
@Html.Partial("_ChildPages", child)
19+
}
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
Due to the fact that Cake Modules are extending and altering the internals of the Cake, the Module Assembly needs to be loaded prior to the main Cake execution. As documented in the Module section of this page, you simply have to do the following:
2+
3+
```
4+
./build.sh --bootstrap
5+
./build.sh
6+
```
7+
8+
This means that the first execution of Cake will inspect your Cake script for any module inclusions in your script, and if there are any, download and install them. And the second execution will then be able to use those modules, and complete the usage of the module.
9+
10+
An example of a Cake script which both includes the module definition for the DotNet Tool Module, and which also uses it, is shown below:
11+
12+
```
13+
#module nuget:?package=Cake.DotNetTool.Module&version=0.1.0
14+
#tool "dotnet:?package=Octopus.DotNet.Cli&version=4.41.0"
15+
```
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
Order: 2
3+
Description: How to obtain Cake.DotNetTool.Module.
4+
---
5+
<p>@Html.Raw(Model.String(DocsKeys.Description))</p>
6+
7+
@Html.Partial("_ChildPages")

docs/input/docs/usage/examples.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Installing a tool using the DotNetTool Cake Module is as simple as:
2+
3+
```
4+
#tool dotnet:?package=Octopus.DotNet.Cli&version=4.41.0
5+
```
6+
7+
If the tool in question comes from a different source, you can change that as follows:
8+
9+
```
10+
#tool dotnet:?package=Octopus.DotNet.Cli&version=4.41.0
11+
```

docs/input/docs/usage/index.cshtml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
Order: 2
3+
Description: How to configure, and execute Cake.DotNetTool.Module.
4+
---
5+
<p>@Html.Raw(Model.String(DocsKeys.Description))</p>
6+
7+
@Html.Partial("_ChildPages")

0 commit comments

Comments
 (0)