Browse Source

Add Zuul FAQ page

As Zuul gets more attention we are getting questions that can likely be
captured in an FAQ and hopefully make the answers easier to find. Add
this document to the website.

Change-Id: Ia076c4f5b3a3949dd8e79ac5825189fb64645950
changes/70/679670/8
Clark Boylan 2 weeks ago
parent
commit
c897715571
5 changed files with 191 additions and 0 deletions
  1. 2
    0
      www/community.html
  2. 175
    0
      www/docs/faq.html
  3. 10
    0
      www/docs/index.html
  4. 2
    0
      www/index.html
  5. 2
    0
      www/users.html

+ 2
- 0
www/community.html View File

@@ -45,6 +45,7 @@
45 45
                     <li><a href="docs/zuul-jobs">Zuul Jobs</a></li>
46 46
                     <li><a href="docs/zuul-base-jobs">Base Jobs</a></li>
47 47
                     <li><a href="docs/zuul-sphinx/">Zuul Sphinx</a></li>
48
+                    <li><a href="docs/faq.html">Zuul FAQ</a></li>
48 49
                   </ul>
49 50
                 </li>
50 51
 		<li class="current"><a href="community.html">Community</a></li>
@@ -98,6 +99,7 @@
98 99
                   <li><a href="https://opendev.org/zuul/zuul/">Source</a></li>
99 100
                   <li><a href="https://pypi.org/project/zuul/">Install</a></li>
100 101
                   <li><a href="https://zuul-ci.org/docs/">Documentation</a></li>
102
+                  <li><a href="https://zuul-ci.org/docs/faq.html">FAQ</a></li>
101 103
                 </ul>
102 104
               </section>
103 105
               <section class="3u 6u$(narrower) 12u$(mobilep)">

+ 175
- 0
www/docs/faq.html View File

@@ -0,0 +1,175 @@
1
+<!DOCTYPE HTML>
2
+<!--
3
+  Arcana by HTML5 UP
4
+  html5up.net | @ajlkn
5
+  Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)
6
+-->
7
+<html>
8
+  <head>
9
+    <title>Zuul: FAQ</title>
10
+    <meta charset="utf-8" />
11
+    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png">
12
+    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
13
+    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
14
+    <link rel="manifest" href="/site.webmanifest">
15
+    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#071d49">
16
+    <meta name="msapplication-TileColor" content="#00aba9">
17
+    <meta name="theme-color" content="#ffffff">
18
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
19
+    <!--[if lte IE 8]><script src="../assets/js/ie/html5shiv.js"></script><![endif]-->
20
+    <link rel="stylesheet" href="../assets/css/main.css" />
21
+    <!--[if lte IE 8]><link rel="stylesheet" href="../assets/css/ie8.css" /><![endif]-->
22
+    <!--[if lte IE 9]><link rel="stylesheet" href="../assets/css/ie9.css" /><![endif]-->
23
+  </head>
24
+  <body>
25
+    <div id="page-wrapper">
26
+
27
+      <!-- Header -->
28
+        <div id="header">
29
+
30
+          <!-- Logo -->
31
+            <h1>
32
+              <a href="/"><img id="logo" src="../images/logo.svg" alt="Zuul"/></a>
33
+            </h1>
34
+
35
+          <!-- Nav -->
36
+            <nav id="nav">
37
+              <ul>
38
+                <li><a href="/">Home</a></li>
39
+		<li><a href="../users.html">Users</a></li>
40
+                <li class="current">
41
+                  <a href=".">Documentation</a>
42
+                  <ul>
43
+                    <li><a href="zuul/">Zuul</a></li>
44
+                    <li><a href="nodepool/">Nodepool</a></li>
45
+                    <li><a href="zuul-jobs/">Zuul Jobs</a></li>
46
+                    <li><a href="zuul-base-jobs/">Base Jobs</a></li>
47
+                    <li><a href="zuul-sphinx/">Zuul Sphinx</a></li>
48
+                    <li><a href="faq.html">Zuul FAQ</a></li>
49
+                  </ul>
50
+                </li>
51
+		<li><a href="/community.html">Community</a></li>
52
+              </ul>
53
+            </nav>
54
+        </div>
55
+
56
+        <section class="wrapper style1">
57
+          <div class="container">
58
+	    <div id="content">
59
+	      <article>
60
+                <header class="major">
61
+                  <h2>Zuul FAQ</h2>
62
+                </header>
63
+		<h3>
64
+		What version control systems does Zuul support?
65
+		</h3>
66
+		<p>
67
+		Zuul currently only has support for the git version control
68
+		system.
69
+		</p>
70
+
71
+                <h3>
72
+		What code review systems does Zuul support?
73
+		</h3>
74
+		<p>
75
+		Zuul currently supports Gerrit, GitHub, GitHub Enterprise,
76
+		and Pagure. Work is in progress to add Bitbucket support.
77
+		</p>
78
+
79
+                <h3>
80
+		Where can I run my Zuul jobs?
81
+		</h3>
82
+		<p>
83
+		Zuul uses Ansible to execute jobs which means Zuul can run jobs
84
+		on platforms that Ansible is able to communicate with. This
85
+		includes Linux (and other Unix like operating systems), Windows,
86
+		and even network switches.
87
+		</p>
88
+
89
+		<p>
90
+		To provision these resources Zuul uses Nodepool which can talk
91
+		to a variety of cloud resources as well as staticly configured
92
+		hosts. Currently AWS, Kubernetes, OpenShift and OpenStack cloud
93
+		resources are supported. Work to support Azure is in progress.
94
+		</p>
95
+
96
+                <h3>
97
+		How does Zuul compare to Jenkins?
98
+		</h3>
99
+		<p>
100
+		Zuul is purpose built to be a gating continuous integration and
101
+		deployment system. Jenkins is a generic automation tool that
102
+		can be used to perform CI and CD.
103
+
104
+		Major differences that come out of this include:
105
+		<ul>
106
+		  <li>Zuul expects all configuration to be managed as code.</li>
107
+		  <li>Zuul provides test environment provisioning via Nodepool.</li>
108
+		  <li>Zuul includes out of the box support for gating commits.</li>
109
+		</ul>
110
+		</p>
111
+
112
+		<h3>
113
+		What are the system requirements to run Zuul?
114
+		</h3>
115
+		<p>
116
+		Zuul scales with the size of your code base. An all in one
117
+		Zuul installation capable of running small workloads will fit
118
+		a server with 8GB of memory and 80GB of disk (this is how we
119
+		test Zuul).
120
+
121
+		For bigger projects you can run multiple Zuul executors and
122
+		mergers to handle larger numbers of concurrent jobs. This means
123
+		you can start small and expand as needed to meet demand.
124
+		</p>
125
+	      </article>
126
+	    </div>
127
+	  </div>
128
+	</section>
129
+
130
+      <!-- Footer -->
131
+        <div id="footer">
132
+          <div class="container">
133
+            <div class="row">
134
+              <section class="3u 6u(narrower) 12u$(mobilep)">
135
+                <h3>Get Zuul</h3>
136
+                <ul class="links">
137
+                  <li><a href="https://opendev.org/zuul/zuul/">Source</a></li>
138
+                  <li><a href="https://pypi.org/project/zuul/">Install</a></li>
139
+                  <li><a href="https://zuul-ci.org/docs/">Documentation</a></li>
140
+                  <li><a href="https://zuul-ci.org/docs/faq.html">FAQ</a></li>
141
+                </ul>
142
+              </section>
143
+              <section class="3u 6u$(narrower) 12u$(mobilep)">
144
+                <h3>Get Involved</h3>
145
+                <ul class="links">
146
+                  <li><a href="http://lists.zuul-ci.org/cgi-bin/mailman/listinfo">Mailing lists</a></li>
147
+                  <li><a href="http://webchat.freenode.net/?channels=%23zuul">IRC</a> #zuul on Freenode</li>
148
+                  <li><a href="https://storyboard.openstack.org/#!/project/679">Bugs</a></li>
149
+                  <li><a href="https://review.opendev.org/#/q/status:open+project:zuul/zuul">Code Review</a></li>
150
+                </ul>
151
+              </section>
152
+            </div>
153
+          </div>
154
+
155
+          <!-- Copyright -->
156
+            <div class="copyright">
157
+              <ul class="menu">
158
+                <li>&copy; Zuul Contributors. Licensed under Creative Commons Attribution 3.0</li><li>Zuul is collaboratively developed under the Apache 2 license and managed by the OpenStack Foundation.</li><li>Design based on Arcana from: <a href="http://html5up.net">HTML5 UP</a></li><li><a href="https://opendev.org/zuul/zuul-website/">Browse page source</a></li>
159
+              </ul>
160
+            </div>
161
+
162
+        </div>
163
+
164
+    </div>
165
+
166
+    <!-- Scripts -->
167
+      <script src="../assets/js/jquery.min.js"></script>
168
+      <script src="../assets/js/jquery.dropotron.min.js"></script>
169
+      <script src="../assets/js/skel.min.js"></script>
170
+      <script src="../assets/js/util.js"></script>
171
+      <!--[if lte IE 8]><script src="../assets/js/ie/respond.min.js"></script><![endif]-->
172
+      <script src="../assets/js/main.js"></script>
173
+
174
+  </body>
175
+</html>

+ 10
- 0
www/docs/index.html View File

@@ -45,6 +45,7 @@
45 45
                     <li><a href="zuul-jobs/">Zuul Jobs</a></li>
46 46
                     <li><a href="zuul-base-jobs/">Base Jobs</a></li>
47 47
                     <li><a href="zuul-sphinx/">Zuul Sphinx</a></li>
48
+                    <li><a href="faq.html">Zuul FAQ</a></li>
48 49
                   </ul>
49 50
                 </li>
50 51
 		<li><a href="/community.html">Community</a></li>
@@ -101,6 +102,14 @@
101 102
                   </div>
102 103
                 </div>
103 104
               </section>
105
+              <section class="6u 12u(narrower)">
106
+                <div class="box post">
107
+                  <div class="inner">
108
+                    <h3><a href="faq.html">Zuul FAQ</a></h3>
109
+                    <p>Find answers to common questions.</p>
110
+                  </div>
111
+                </div>
112
+              </section>
104 113
             </div>
105 114
           </div>
106 115
         </section>
@@ -115,6 +124,7 @@
115 124
                   <li><a href="https://opendev.org/zuul/zuul/">Source</a></li>
116 125
                   <li><a href="https://pypi.org/project/zuul/">Install</a></li>
117 126
                   <li><a href="https://zuul-ci.org/docs/">Documentation</a></li>
127
+                  <li><a href="https://zuul-ci.org/docs/faq.html">FAQ</a></li>
118 128
                 </ul>
119 129
               </section>
120 130
               <section class="3u 6u$(narrower) 12u$(mobilep)">

+ 2
- 0
www/index.html View File

@@ -45,6 +45,7 @@
45 45
                     <li><a href="docs/zuul-jobs">Zuul Jobs</a></li>
46 46
                     <li><a href="docs/zuul-base-jobs">Base Jobs</a></li>
47 47
                     <li><a href="docs/zuul-sphinx/">Zuul Sphinx</a></li>
48
+                    <li><a href="docs/faq.html">Zuul FAQ</a></li>
48 49
                   </ul>
49 50
                 </li>
50 51
 		<li><a href="community.html">Community</a></li>
@@ -215,6 +216,7 @@
215 216
                   <li><a href="https://opendev.org/zuul/zuul/">Source</a></li>
216 217
                   <li><a href="https://pypi.org/project/zuul/">Install</a></li>
217 218
                   <li><a href="https://zuul-ci.org/docs/">Documentation</a></li>
219
+                  <li><a href="https://zuul-ci.org/docs/faq.html">FAQ</a></li>
218 220
                 </ul>
219 221
               </section>
220 222
               <section class="3u 6u$(narrower) 12u$(mobilep)">

+ 2
- 0
www/users.html View File

@@ -45,6 +45,7 @@
45 45
                     <li><a href="docs/zuul-jobs">Zuul Jobs</a></li>
46 46
                     <li><a href="docs/zuul-base-jobs">Base Jobs</a></li>
47 47
                     <li><a href="docs/zuul-sphinx/">Zuul Sphinx</a></li>
48
+                    <li><a href="docs/faq.html">Zuul FAQ</a></li>
48 49
                   </ul>
49 50
                 </li>
50 51
 		<li><a href="community.html">Community</a></li>
@@ -227,6 +228,7 @@
227 228
                   <li><a href="https://opendev.org/zuul/zuul/">Source</a></li>
228 229
                   <li><a href="https://pypi.org/project/zuul/">Install</a></li>
229 230
                   <li><a href="https://zuul-ci.org/docs/">Documentation</a></li>
231
+                  <li><a href="https://zuul-ci.org/docs/faq.html">FAQ</a></li>
230 232
                 </ul>
231 233
               </section>
232 234
               <section class="3u 6u$(narrower) 12u$(mobilep)">

Loading…
Cancel
Save