forked from ManageIQ/manageiq-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index-community.html
112 lines (108 loc) · 5.89 KB
/
index-community.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="ManageIQ Documentation">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<title>ManageIQ Docmentation</title>
<!-- Bootstrap -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap-theme.min.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="shortcut icon" href="http://manageiq.org/images/favicon.ico" type="image/x-icon"/>
<link rel="image_src" href="http://manageiq.org/images/logo/manageiq-logo-standard.svg"/>
</head>
<body>
<div class="container">
<div class="row">
<div class="page-header" style='background-image: url("http://manageiq.org/images/header-paintedcandy.jpg"); background-position: center; background-repeat: no-repeat; background-size: cover;'>
<img src="http://manageiq.org/images/logo/manageiq-logo-standard.svg" class="img-responsive" />
</div>
</div>
<div class="row">
<div class="col-md-8">
<h4><strong>What <em>is</em> ManageIQ?</strong></h4>
<p>AsciiBinder is a documentation system built on <a href="http://asciidoctor.org/">Asciidoctor</a> for people who have a lot of docs to maintain and republish on a regular basis. AsciiBinder was specifically developed to solve two problems at once:</p>
<ul>
<li>Make it easier for developers and community members to contribute documentation.</li>
<li>Make it easier for content managers to build and publish several variants of the same documentation.</li>
</ul>
<p> </p>
<h4><strong>AsciiBinder isn't for blogging.</strong></h4>
<p>If you are looking for a great tool for blogging where your articles are sourced in AsciiDoc, <em>this isn't it</em>. Seriously, go check out <a href="http://awestruct.org/">Awestruct</a>, which is awesome for that.</p>
<p> </p>
<h4><strong>AsciiBinder is for documenting versioned, interrelated projects.</strong></h4>
<p>On the other hand, if you are looking for a way to:</p>
<ul>
<li>Source your docs in AsciiDoc</li>
<li>Manage doc changes and doc versions with git</li>
<li>Have the ability to conditionalize topics and produce different <em>distributions</em> of the docs based on those conditions</li>
</ul>
<p>...then by jove, you've come to the right place.</p>
<p> </p>
</div>
<div class="col-md-4">
<h4><strong>Installation</strong></h4>
<ol>
<li>Install Ruby</li>
<li>Install a Java JVM (for <a href="http://ditaa.sourceforge.net/">ditaa</a> support)
<li><code>gem install ascii_binder</code></li>
</ol>
<p> </p>
<h4><strong>Documentation</strong></h4>
<div class="list-group">
<a href="/latest/welcome/" class="list-group-item">
<span class="glyphicon glyphicon-pencil" aria-hidden="true"></span>
<span class="sr-only">Pencil</span>
Latest Documentation
</a>
<a href="/latest/guides/user_guide.html" class="list-group-item">
<span class="glyphicon glyphicon-cog" aria-hidden="true"></span>
<span class="sr-only">Gear</span>
AsciiBinder User's Guide
</a>
<a href="/latest/guides/maintainer_guide.html" class="list-group-item">
<span class="glyphicon glyphicon-wrench" aria-hidden="true"></span>
<span class="sr-only">Wrench</span>
AsciiBinder Maintainer's Guide
</a>
</div>
<p> </p>
<h4><strong>Get Involved!</strong></h4>
<div class="list-group">
<a href="https://github.com/ManageIQ" class="list-group-item">
<span class="glyphicon glyphicon-eye-open" aria-hidden="true"></span>
<span class="sr-only">GitHub</span>
ManageIQ organization on GitHub
</a>
<a href="https://github.com/ManageIQ/manageiq" class="list-group-item">
<span class="glyphicon glyphicon-eye-open" aria-hidden="true"></span>
<span class="sr-only">GitHub</span>
ManageIQ project on GitHub
</a>
<a href="https://twitter.com/manageiq" class="list-group-item">
<span class="glyphicon glyphicon-bullhorn" aria-hidden="true"></span>
<span class="sr-only">Twitter</span>
@manageiq on Twitter
</a>
</div>
</div>
</div>
<div class="row">
<hr />
<p class="small">ManageIQ is an open source project dual licensed under the <a href="https://github.com/manageiq/manageiq/blob/master/LICENSE.txt">Apache License 2.0 or GPLv2</a>.</p>
</div>
</div>
<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
<!-- Include all compiled plugins (below), or include individual files as needed -->
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js"></script>
</body>
</html>