Skip to content

Commit 21b2514

Browse files
committed
Update docs for beta7
1 parent e3e598b commit 21b2514

File tree

7 files changed

+111
-1
lines changed

7 files changed

+111
-1
lines changed

doc/angularjs-api-module.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
layout: default
3+
currentMenu: angularjs-api-module
4+
---
5+
6+
# AngularJS Client
7+
8+
The [eeh-inengine-api](https://github.com/ethanhann/eeh-inengine-api) AngularJS module is
9+
used to programmatically access the Web API in an AngularJS web application.
10+
It is used in the [InEngine.NET Dashboard](dashboard.html) and can be included in 3rd party projects.
11+
12+
It package available via Bower.
13+
```sh
14+
bower install eeh-inengine-api --save
15+
```

doc/client-library.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
layout: default
3+
currentMenu: client-library
4+
---
5+
6+
# InEngine.NET Client
7+
8+
The [InEngine.NET Client](https://www.nuget.org/packages/IntegrationEngine.Client) package contains a library that is
9+
used to programmatically access the Web API.
10+
It is used in the [InEngine.NET Console Client](console-client.html) and can be included in 3rd party projects.

doc/console-client.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
layout: default
3+
currentMenu: console-client
4+
---
5+
6+
# Console Client
7+
8+
The console client is a Windows program that allows CLI access to the __Web API__.
9+
It uses the [InEngine.NET Client](client-library.html) library to accomplish.

doc/couscous.yml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,22 @@ menu:
3737
text: Web API
3838
iconClass: 'fa fa-fw fa-cloud'
3939
relativeUrl: web-api/cron-trigger.html
40-
40+
client-library:
41+
text: C# Client Library
42+
iconClass: 'fa fa-fw fa-desktop'
43+
relativeUrl: client-library.html
44+
console-client:
45+
text: Console Client
46+
iconClass: 'fa fa-fw fa-terminal'
47+
relativeUrl: console-client.html
48+
angularjs-api-module:
49+
text: AngularJS Client
50+
iconClass: 'fa fa-fw fa-desktop'
51+
relativeUrl: angularjs-api-module.html
52+
dashboard:
53+
text: Web Dashboard
54+
iconClass: 'fa fa-fw fa-dashboard'
55+
relativeUrl: dashboard.html
4156
webApiMenu:
4257
items:
4358
cron-trigger:

doc/dashboard.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: default
3+
currentMenu: dashboard
4+
---
5+
6+
# Web Dashboard
7+
8+
The dashboard is a web front-end, built with AngularJS, for the InEngine.NET Web API.
9+
It uses the [eeh-inengine-api](angularjs-api-module.html) AngularJS API Module to access the API.
10+
11+
The dashboard source is available on [GitHub](https://github.com/ethanhann/InEngine.NET-Dashboard).
12+
13+
## Configuration
14+
15+
Be sure to add the domain the dashboard is served from to the WebAPI/Origins section of the [IntegrationEngine.json file](configuration.html).
16+
17+
## Serving the Dashboard
18+
19+
The dashboard is not served from the web API.
20+
It is a Node.js application.
21+
To build and serve the dashboard, first download and install [Node.js](http://nodejs.org/),
22+
then navigate to the root of the project use NPM to install dependencies.
23+
24+
```sh
25+
npm install
26+
```
27+
28+
Now, use NPM to serve the dashboard.
29+
30+
```sh
31+
npm start
32+
```
33+
34+
The dashboard will be served at _http://localhost:3000_.
35+
36+
Though the dashboard is served by Node.js, any web server can serve it since the dashboard is merely a collection of static files.
37+
IIS, Apache HTTP Server, and Nginx are all options.

doc/documentation.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,15 @@ The [Integration Jobs documentation](configuration.html) lists the built-in inte
1717

1818
The [Web API documentation](configuration.html) lists the available HTTP endpoints, and explains their usage.
1919

20+
## InEngine.NET Client
21+
22+
The [InEngine.NET Client documentation](client-library.html) lists the available methods for interacting with the Web API in the client library, and explains their usage.
23+
24+
## InEngine.NET Console
25+
26+
The [InEngine.NET Console documentation](console-client.html) lists the available CLI commands, and explains their usage.
27+
28+
## InEngine.NET Console
29+
30+
The [InEngine.NET Console documentation](console-client.html) lists the available CLI commands, and explains their usage.
31+

doc/website/css/main.css

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,3 +152,15 @@ pre code {
152152
.nav.nav-sub-items li a {
153153
padding-left: 1.6em;
154154
}
155+
156+
.nav-stacked > li + li,
157+
.nav-pills > li {
158+
margin-top: 0;
159+
margin-bottom: 0;
160+
}
161+
162+
.nav-pills > li > a {
163+
border-radius: 0;
164+
padding-top: 6px;
165+
padding-bottom: 6px;
166+
}

0 commit comments

Comments
 (0)