Skip to content

Commit 9c2a722

Browse files
Merge pull request #237 from CrunchyData/revert-234-typofix
Revert "Fixes name of database in example tutorial"
2 parents bee77ea + f25cf1b commit 9c2a722

File tree

17 files changed

+3643
-2177
lines changed

17 files changed

+3643
-2177
lines changed

docs/404.html

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

66
<meta charset="utf-8">
77
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
8-
<meta name="generator" content="Hugo 0.40.3" />
8+
<meta name="generator" content="Hugo 0.40" />
99

1010
<title>404 Page not found :: Crunchy Data PostgreSQL Operator Documentation</title>
1111
<link rel="shortcut icon" href="https://crunchydata.github.io/postgres-operator/favicon.ico" type="image/x-icon" />

docs/categories/index.html

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

66
<meta charset="utf-8">
77
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
8-
<meta name="generator" content="Hugo 0.40.3" />
8+
<meta name="generator" content="Hugo 0.40" />
99

1010
<title>Categories :: Crunchy Data PostgreSQL Operator Documentation</title>
1111
<link rel="shortcut icon" href="https://crunchydata.github.io/postgres-operator/favicon.ico" type="image/x-icon" />

docs/contributing/index.html

Lines changed: 41 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
<meta charset="utf-8">
77
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
8-
<meta name="generator" content="Hugo 0.40.3" />
8+
<meta name="generator" content="Hugo 0.40" />
99

1010
<title>Contributing :: Crunchy Data PostgreSQL Operator Documentation</title>
1111
<link rel="shortcut icon" href="https://crunchydata.github.io/postgres-operator/favicon.ico" type="image/x-icon" />
@@ -219,34 +219,47 @@ <h1>Contributing</h1>
219219

220220

221221

222-
v3.0, {docdate}
223-
224-
== Getting Started
225-
226-
Welcome! Thank you for your interest in contributing. Before submitting a new link:https://github.com/CrunchyData/postgres-operator/issues/new[issue]
227-
or link:https://github.com/CrunchyData/postgres-operator/pulls[pull request] to the link:https://github.com/CrunchyData/postgres-operator/[Crunchy Data
228-
PostgreSQL Operator] project on GitHub, *please review any open or closed issues* link:https://github.com/crunchydata/postgres-operator/issues[here]
229-
in addition to any existing open pull requests.
230-
231-
== Documentation
232-
233-
The documentation website (located at https://crunchydata.github.io/postgres-operator/) is generated using link:https://gohugo.io/[Hugo] and
234-
link:https://pages.github.com/[GitHub Pages]. If you would like to build the documentation locally, view the
235-
link:https://gohugo.io/getting-started/installing/[official Installing Hugo] guide to set up Hugo locally. You can then start the server by
236-
running the following commands -
237-
238-
....
239-
cd $COROOT/hugo/
222+
<div class="paragraph">
223+
<p>v3.0, 2018-05-23</p>
224+
</div>
225+
<div class="sect1">
226+
<h2 id="_getting_started">Getting Started</h2>
227+
<div class="sectionbody">
228+
<div class="paragraph">
229+
<p>Welcome! Thank you for your interest in contributing. Before submitting a new <a href="https://github.com/CrunchyData/postgres-operator/issues/new">issue</a>
230+
or <a href="https://github.com/CrunchyData/postgres-operator/pulls">pull request</a> to the <a href="https://github.com/CrunchyData/postgres-operator/">Crunchy Data
231+
PostgreSQL Operator</a> project on GitHub, <strong>please review any open or closed issues</strong> <a href="https://github.com/crunchydata/postgres-operator/issues">here</a>
232+
in addition to any existing open pull requests.</p>
233+
</div>
234+
</div>
235+
</div>
236+
<div class="sect1">
237+
<h2 id="_documentation">Documentation</h2>
238+
<div class="sectionbody">
239+
<div class="paragraph">
240+
<p>The documentation website (located at <a href="https://crunchydata.github.io/postgres-operator/" class="bare">https://crunchydata.github.io/postgres-operator/</a>) is generated using <a href="https://gohugo.io/">Hugo</a> and
241+
<a href="https://pages.github.com/">GitHub Pages</a>. If you would like to build the documentation locally, view the
242+
<a href="https://gohugo.io/getting-started/installing/">official Installing Hugo</a> guide to set up Hugo locally. You can then start the server by
243+
running the following commands -</p>
244+
</div>
245+
<div class="literalblock">
246+
<div class="content">
247+
<pre>cd $COROOT/hugo/
240248
vi config.toml
241-
hugo server
242-
....
243-
244-
When you edit *config.toml*, you'll set `baseURL = "/"`. This will make the local version of the Hugo server accessible by default from
245-
`localhost:1313`. Once you've run `hugo server`, that will let you interactively make changes to the documentation as desired and view the updates
246-
in real-time.
247-
248-
*When you're ready to commit a change*, please view and run the script located at `$COROOT/generate-docs.sh` which will automatically generate a new
249-
set of webpages using Hugo that will update the live website after the change has been committed to the repository.
249+
hugo server</pre>
250+
</div>
251+
</div>
252+
<div class="paragraph">
253+
<p>When you edit <strong>config.toml</strong>, you&#8217;ll set <code>baseURL = "/"</code>. This will make the local version of the Hugo server accessible by default from
254+
<code>localhost:1313</code>. Once you&#8217;ve run <code>hugo server</code>, that will let you interactively make changes to the documentation as desired and view the updates
255+
in real-time.</p>
256+
</div>
257+
<div class="paragraph">
258+
<p><strong>When you&#8217;re ready to commit a change</strong>, please view and run the script located at <code>$COROOT/generate-docs.sh</code> which will automatically generate a new
259+
set of webpages using Hugo that will update the live website after the change has been committed to the repository.</p>
260+
</div>
261+
</div>
262+
</div>
250263

251264

252265

0 commit comments

Comments
 (0)