Skip to content

Commit bfcb168

Browse files
ethanhannethanhann
committed
Update docs
1 parent c89d9eb commit bfcb168

File tree

6 files changed

+171
-38
lines changed

6 files changed

+171
-38
lines changed

‎doc/README.md‎

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,29 @@
11
---
2-
layout: default
2+
layout: home
33
currentMenu: home
44
---
55

6-
# Welcome
6+
## Why should you care?
7+
__InEngine.NET__ is a set of .NET packages that allows for the creation of a code-centric data integration and asynchronous job scheduling server.
8+
Integration jobs are created in code, making them flexible and testable.
79

8-
__InEngine.NET__ is a set of .NET packages, created by [Ethan Hann](http://ethanhann.com), that allows for the
9-
creation of a code-centric data integration and asynchronous job scheduling server.
10-
11-
- [NuGet Package](https://www.nuget.org/packages/IntegrationEngine)
12-
- [GitHub Project](https://github.com/ethanhann/InEngine.NET)
13-
14-
### Why should you care?
15-
16-
Data integration is a common task when working in a large or medium enterprise environment.
17-
Data integration servers take data from a data source, transform it (or not), and put it somewhere.
18-
__InEngine.NET__ can allow you to do that and more in a programmatic manner.
19-
20-
There are several existing full-featured data integration server products on the market.
21-
These products do not work in a way software developers are comfortable with.
10+
Existing commercial data integration server products do not work in a way software developers are comfortable with.
2211
They provide a drag-and-drop GUI application for implementing a data integration.
23-
This sounds appealing on the surface, but such GUIs are often clunky and slow.
24-
Additionally, existing products do not provide a testable way to build integrations and detect when they stop functioning.
12+
This sounds appealing, but such GUIs are often clunky and slow.
13+
Additionally, such products do not provide a testable way to build integrations and detect when they stop functioning.
2514
This is a major issue as data integrations are fragile by nature.
2615

2716
In contrast, a developer would prefer fine-grained, programmatic access to the data they are querying, transforming, and persisting.
2817
A developer would also like to be able to test their integrations to ensure their continued operation.
29-
__InEngine.NET__ provides this.
18+
__InEngine.NET__ allows this.
3019

31-
### How does it work?
32-
33-
1. __InEngine.NET__ is a library. In order to use the library a developer must create a .NET console or service
34-
project that instantiates and initializes an instance of _IntegrationEngine.EngineHost_.
35-
1. Integration jobs that implement _IntegrationEngine.Model.IIntegrationJob_ (located in an assembly passed to _EngineHost_) are loaded.
36-
1. Integration jobs are scheduled by posting a request to the [InEngine.NET Web API](web-api.html).
37-
1. When a job is triggered a message is added to the message queue, defined in [IntegrationEngine.json](configuration.html), that indicates which job to run.
38-
1. When a message is detected, the __InEngine.NET__ job runner plucks the message from the queue and runs the job encoded within it.
20+
## What is the license?
21+
[MIT](https://github.com/ethanhann/InEngine.NET/blob/master/LICENSE)
3922

40-
<img src="https://docs.google.com/drawings/d/1dEmGlhfDWhljOjWIn7ttuNQxfY1N_dXOaHxNOLpgV9U/pub?w=960&amp;h=720" alt="IntegrationEngine Job Processing Diagram" />
23+
## How much does it cost?
24+
It's free!
4125

42-
### How is this software licensed?
43-
[MIT](https://github.com/ethanhann/InEngine.NET/blob/master/LICENSE)
26+
## Where can I get this fantastic software?
27+
The software is released as a set of [NuGet Packages](https://www.nuget.org/packages/IntegrationEngine).
28+
29+
The source code is hosted on [GitHub](https://github.com/ethanhann/InEngine.NET).

‎doc/change-log.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ currentMenu: change-log
55

66
# Change Log
77

8+
## 2.0.0-beta7
9+
10+
__Features__
11+
* Expose additional properties to typed client by pushing their implementations into model assembly.
12+
813
## 2.0.0-beta6
914

1015
__Features__

‎doc/couscous.yml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,17 @@ subTitle: An asynchronous job scheduling server.
99
menu:
1010
items:
1111
home:
12-
text: Welcome
12+
text: Home
1313
iconClass: 'fa fa-fw fa-home'
1414
relativeUrl: index.html
1515
getting-started:
1616
text: Getting Started
1717
iconClass: 'fa fa-fw fa-power-off'
1818
relativeUrl: getting-started.html
19+
change-log:
20+
text: Change Log
21+
iconClass: 'fa fa-fw fa-refresh'
22+
relativeUrl: change-log.html
1923
configuration:
2024
text: Configuration
2125
iconClass: 'fa fa-fw fa-gear'
@@ -28,10 +32,6 @@ menu:
2832
text: Web API
2933
iconClass: 'fa fa-fw fa-cloud'
3034
relativeUrl: web-api/cron-trigger.html
31-
change-log:
32-
text: Change Log
33-
iconClass: 'fa fa-fw fa-refresh'
34-
relativeUrl: change-log.html
3535

3636
webApiMenu:
3737
items:

‎doc/website/css/main.css‎

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ main {
1616
margin-top: 80px;
1717
}
1818

19+
main.home {
20+
margin-top: 0;
21+
}
22+
1923
section {
2024
margin-bottom: 120px;
2125
}
@@ -92,19 +96,26 @@ header.navbar {
9296
position:fixed;
9397
margin-top: 30px;
9498
}
95-
#menu-navbar {
99+
#menu-navbar,
100+
header.home .navbar {
96101
display: none !important;
97102
}
98103
}
99104

100105
@media (max-width: 767px) {
101-
#sidebar {
106+
#sidebar,
107+
header.home .jumbotron,
108+
.jumbo-nav-icons {
102109
display: none !important;
103110
}
104111

105112
.status-badges {
106113
display: none !important;
107114
}
115+
116+
main.home {
117+
margin-top: 80px;
118+
}
108119
}
109120

110121
@media (max-width: 960px) {
@@ -130,6 +141,25 @@ pre {
130141
margin: 15px;
131142
font-size: 15px;
132143
}
144+
133145
pre code {
134146
border: none;
135147
}
148+
149+
.jumbotron {
150+
/*background-color: #f1c40f;*/
151+
background-color: #F7CA18;
152+
box-shadow: 0 1px 2px rgba(0,0,0,0.3);
153+
/*background-image: linear-gradient(to bottom, #ecf0f1, #ecf0f1);*/
154+
}
155+
156+
.jumbotron h1 {
157+
font-size: 90px;
158+
font-weight: 900;
159+
letter-spacing: -2px;
160+
line-height: 100px;
161+
}
162+
163+
.jumbotron .lead {
164+
color: #5F5F5F;
165+
}

‎doc/website/home.twig‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1">
6+
7+
<title>{{ title }}</title>
8+
9+
<link rel="stylesheet" href="{{ baseUrl }}/bower_components/bootswatch/paper/bootstrap.min.css">
10+
<link rel="stylesheet" href="{{ baseUrl }}/bower_components/font-awesome/css/font-awesome.min.css">
11+
<link rel="stylesheet" href="{{ baseUrl }}/bower_components/highlightjs/styles/dark.css">
12+
<link rel="stylesheet" href="{{ baseUrl }}/css/main.css">
13+
</head>
14+
<body>
15+
16+
<header class="home">
17+
<div class="navbar navbar-default navbar-fixed-top">
18+
<div class="navbar-header">
19+
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#menu-navbar">
20+
<span class="sr-only">Toggle navigation</span>
21+
<span class="fa fa-fw fa-bars"></span>
22+
</button>
23+
<a class="navbar-brand" href="{{ baseUrl }}/">
24+
{{ title|default('The title') }}
25+
<small class="hidden-xs hidden-sm">
26+
{{ subTitle|default('This is the default subtitle!') }}
27+
</small>
28+
</a>
29+
</div>
30+
{% if menu is defined %}
31+
<div id="menu-navbar" class="collapse navbar-collapse">
32+
<ul class="nav navbar-nav">
33+
{{ include('menu-items.twig') }}
34+
</ul>
35+
</div>
36+
{% endif %}
37+
</div>
38+
<div class="jumbotron text-center">
39+
<h1>{{ title }}</h1>
40+
<p class="lead">{{ subTitle }}</p>
41+
</div>
42+
</header>
43+
44+
<main class="home">
45+
<div class="container">
46+
<section id="content">
47+
<div class="row text-center jumbo-nav-icons">
48+
{% for itemId, item in menu.items %}
49+
<div class="col-sm-2">
50+
<p>
51+
<a href="{{ item.absoluteUrl|default(baseUrl ~ '/' ~ item.relativeUrl) }}">
52+
<span class="{{ item.iconClass }} fa-5x"></span>
53+
<br>
54+
{{ item.text|raw }}
55+
</a>
56+
57+
<p>
58+
</div>
59+
{% endfor %}
60+
</div>
61+
62+
{#<div class="row text-center">#}
63+
{#<div class="col-md-4">#}
64+
{#<p>#}
65+
{#<a href="getting-started.html">#}
66+
{#<span class="fa fa-fw fa-power-off fa-5x"></span>#}
67+
{#<br>#}
68+
{#<strong>Getting Started</strong>#}
69+
{#</a>#}
70+
{#<p>#}
71+
{#</div>#}
72+
{#<div class="col-md-4">#}
73+
{#<p>#}
74+
{#<a href="change-log.html">#}
75+
{#<span class="fa fa-fw fa-refresh fa-5x"></span>#}
76+
{#<br>#}
77+
{#<strong>Change Log</strong>#}
78+
{#</a>#}
79+
{#<p>#}
80+
{#</div>#}
81+
{#<div class="col-md-4">#}
82+
{#<p>#}
83+
{#<a href="configuration.html">#}
84+
{#<span class="fa fa-fw fa-gear fa-5x"></span>#}
85+
{#<br>#}
86+
{#<strong>Configuration</strong>#}
87+
{#</a>#}
88+
{#<p>#}
89+
{#</div>#}
90+
{#</div>#}
91+
92+
{% block content %}
93+
{{ content|raw }}
94+
{% endblock %}
95+
</section>
96+
</div>
97+
</main>
98+
99+
<footer>
100+
<div class="container">
101+
<p class="text-muted">
102+
author <a href="http://www.ethanhann.com" title="Author">Ethan Hann</a>
103+
</p>
104+
</div>
105+
</footer>
106+
107+
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
108+
<script src="bower_components/jquery/dist/jquery.min.js"></script>
109+
<script src="bower_components/bootstrap/dist/js/bootstrap.min.js"></script>
110+
111+
</body>
112+
</html>

‎doc/website/web-api.twig‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
{% block content %}
44
<h2>Web API</h2>
5-
<ul class="nav nav-pills">
5+
<ul class="nav nav-tabs">
66
{% for itemId, item in webApiMenu.items %}
77
<li class="{{ itemId == currentSubMenu ? 'active' }}">
88
<a href="{{ item.absoluteUrl|default(baseUrl ~ '/' ~ item.relativeUrl) }}">

0 commit comments

Comments
 (0)