Skip to content

Commit 943c96f

Browse files
sxdsxd
committed
Revert "docs: remove old documentation source code (#400)"
This reverts commit fc0975b.
1 parent 41d6c64 commit 943c96f

File tree

4,904 files changed

+1498391
-8
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,904 files changed

+1498391
-8
lines changed

‎README.md‎

Lines changed: 52 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,58 @@ Edit the file, and once happy remove the `draft: true` - it should now show up f
7575

7676
### Documentation
7777

78-
Documentation lives [alongside the operator
79-
code](https://github.com/cloudnative-pg/cloudnative-pg), inside the
80-
`docs/src` folder, is written in Markdown and compiled in a website
81-
using Docusaurus.
82-
83-
The source code of the [documentation
84-
website](https://cloudnative-pg.io/docs) is hosted in the [docs
85-
repository](https://github.com/cloudnative-pg/docs).
78+
Documentation lives [alongside the operator code](https://github.com/cloudnative-pg/cloudnative-pg),
79+
inside the `docs/src` folder. It is written in Markdown using mkdocs.
80+
81+
The website contains a static copy of the HTML files generated from the
82+
Markdown sources, inside the `assets/documentation/$version_number` folder
83+
(where $version_number is a **minor** release of CloudNativePG).
84+
85+
The `hack/import_docs.sh` script has the logic to import the files from a
86+
release branch, generate the HTML and save the files in the appropriate folder.
87+
88+
Below you find instructions on how to update the docs for a new minor release
89+
or a patch release.
90+
91+
#### New minor release
92+
93+
Create a new file called `X.Y.md` (X.Y matching the minor release branch in the
94+
operator repo) inside the `content/docs` folder, with the following content:
95+
96+
```markdown
97+
---
98+
release: X.Y.0
99+
location: /documentation/X.Y
100+
release_date: DD Mon Year
101+
release_notes: https://github.com/cloudnative-pg/cloudnative-pg/releases/tag/vX.Y.0
102+
---
103+
```
104+
105+
Then run:
106+
107+
```console
108+
hack/import_docs.sh X.Y
109+
```
110+
111+
This will import all the files under `assets/documentation/X.Y`. Open the
112+
top-level `./assets/documentation/X.Y/index.html` page with your browser and
113+
verify everything is OK, then add the folder to the Git repo (in a development
114+
branch).
115+
116+
#### New patch release
117+
118+
Modify the `X.Y.md` file inside `content/docs` folder by updating the version
119+
and the release date.
120+
121+
Then run:
122+
123+
```console
124+
hack/import_docs.sh X.Y
125+
```
126+
127+
Apply all changes in the development branch and push. If you are adding a new
128+
patch release to the latest minor version, you will need to update the
129+
`current` branch (which at the moment is a copy of the folder).
86130

87131
## Publishing on the website
88132

‎archetypes/docs.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
release: {{ replace .Name "-" " " | title }}
3+
location: /documentation/{{ replace .Name "-" " " | title }}
4+
release_date: {{ .Date }}
5+
release_notes: https://github.com/cloudnative-pg/cloudnative-pg/releases/tag/v{{ replace .Name "-" " " | title }}
6+
---

‎assets/documentation/1.15.0/index.html‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>CloudNativePG Documentation 1.15.0 has been moved</title>
5+
<meta http-equiv = "refresh" content = "0; url = https://cloudnative-pg.io/documentation/1.15/" />
6+
<link rel="canonical" href="https://cloudnative-pg.io/documentation/1.15/">
7+
</head>
8+
<body>
9+
<p>The documentation for <a href="https://cloudnative-pg.io/documentation/1.15/">CloudNativePG 1.15.0</a> is not available anymore. It is now part of the 1.15 minor release documentation.</p>
10+
</body>
11+
</html>

‎assets/documentation/1.15.1/index.html‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>CloudNativePG Documentation 1.15.1 has been moved</title>
5+
<meta http-equiv = "refresh" content = "0; url = https://cloudnative-pg.io/documentation/1.15/" />
6+
<link rel="canonical" href="https://cloudnative-pg.io/documentation/1.15/">
7+
</head>
8+
<body>
9+
<p>The documentation for <a href="https://cloudnative-pg.io/documentation/1.15/">CloudNativePG 1.15.1</a> is not available anymore. It is now part of the 1.15 minor release documentation.</p>
10+
</body>
11+
</html>

‎assets/documentation/1.15/404.html‎

Lines changed: 270 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,270 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en" >
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="The CloudNativePG Contributors" />
7+
<link rel="shortcut icon" href="/img/favicon.ico" />
8+
<title>CloudNativePG</title>
9+
<link rel="stylesheet" href="/css/theme.css" />
10+
<link rel="stylesheet" href="/css/theme_extra.css" />
11+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
12+
13+
<script src="/js/jquery-3.6.0.min.js" defer></script>
14+
<!--[if lt IE 9]>
15+
<script src="/js/html5shiv.min.js"></script>
16+
<![endif]-->
17+
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
18+
<script>hljs.initHighlightingOnLoad();</script>
19+
</head>
20+
21+
<body class="wy-body-for-nav" role="document">
22+
23+
<div class="wy-grid-for-nav">
24+
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
25+
<div class="wy-side-scroll">
26+
<div class="wy-side-nav-search">
27+
<a href="/." class="icon icon-home"> CloudNativePG
28+
</a><div role="search">
29+
<form id ="rtd-search-form" class="wy-form" action="//search.html" method="get">
30+
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
31+
</form>
32+
</div>
33+
</div>
34+
35+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
36+
<ul>
37+
<li class="toctree-l1"><a class="reference internal" href="/.">CloudNativePG</a>
38+
</li>
39+
</ul>
40+
<ul>
41+
<li class="toctree-l1"><a class="reference internal" href="/before_you_start/">Before You Start</a>
42+
</li>
43+
</ul>
44+
<ul>
45+
<li class="toctree-l1"><a class="reference internal" href="/use_cases/">Use cases</a>
46+
</li>
47+
</ul>
48+
<ul>
49+
<li class="toctree-l1"><a class="reference internal" href="/architecture/">Architecture</a>
50+
</li>
51+
</ul>
52+
<ul>
53+
<li class="toctree-l1"><a class="reference internal" href="/installation_upgrade/">Installation and upgrades</a>
54+
</li>
55+
</ul>
56+
<ul>
57+
<li class="toctree-l1"><a class="reference internal" href="/quickstart/">Quickstart</a>
58+
</li>
59+
</ul>
60+
<ul>
61+
<li class="toctree-l1"><a class="reference internal" href="/bootstrap/">Bootstrap</a>
62+
</li>
63+
</ul>
64+
<ul>
65+
<li class="toctree-l1"><a class="reference internal" href="/security/">Security</a>
66+
</li>
67+
</ul>
68+
<ul>
69+
<li class="toctree-l1"><a class="reference internal" href="/instance_manager/">Postgres instance manager</a>
70+
</li>
71+
</ul>
72+
<ul>
73+
<li class="toctree-l1"><a class="reference internal" href="/scheduling/">Scheduling</a>
74+
</li>
75+
</ul>
76+
<ul>
77+
<li class="toctree-l1"><a class="reference internal" href="/resource_management/">Resource management</a>
78+
</li>
79+
</ul>
80+
<ul>
81+
<li class="toctree-l1"><a class="reference internal" href="/failure_modes/">Failure Modes</a>
82+
</li>
83+
</ul>
84+
<ul>
85+
<li class="toctree-l1"><a class="reference internal" href="/rolling_update/">Rolling Updates</a>
86+
</li>
87+
</ul>
88+
<ul>
89+
<li class="toctree-l1"><a class="reference internal" href="/replication/">Replication</a>
90+
</li>
91+
</ul>
92+
<ul>
93+
<li class="toctree-l1"><a class="reference internal" href="/backup_recovery/">Backup and Recovery</a>
94+
</li>
95+
</ul>
96+
<ul>
97+
<li class="toctree-l1"><a class="reference internal" href="/postgresql_conf/">PostgreSQL Configuration</a>
98+
</li>
99+
</ul>
100+
<ul>
101+
<li class="toctree-l1"><a class="reference internal" href="/operator_conf/">Operator configuration</a>
102+
</li>
103+
</ul>
104+
<ul>
105+
<li class="toctree-l1"><a class="reference internal" href="/storage/">Storage</a>
106+
</li>
107+
</ul>
108+
<ul>
109+
<li class="toctree-l1"><a class="reference internal" href="/labels_annotations/">Labels and annotations</a>
110+
</li>
111+
</ul>
112+
<ul>
113+
<li class="toctree-l1"><a class="reference internal" href="/monitoring/">Monitoring</a>
114+
</li>
115+
</ul>
116+
<ul>
117+
<li class="toctree-l1"><a class="reference internal" href="/logging/">Logging</a>
118+
</li>
119+
</ul>
120+
<ul>
121+
<li class="toctree-l1"><a class="reference internal" href="/certificates/">Certificates</a>
122+
</li>
123+
</ul>
124+
<ul>
125+
<li class="toctree-l1"><a class="reference internal" href="/ssl_connections/">Client TLS/SSL Connections</a>
126+
</li>
127+
</ul>
128+
<ul>
129+
<li class="toctree-l1"><a class="reference internal" href="/applications/">Connecting from an application</a>
130+
</li>
131+
</ul>
132+
<ul>
133+
<li class="toctree-l1"><a class="reference internal" href="/connection_pooling/">Connection Pooling</a>
134+
</li>
135+
</ul>
136+
<ul>
137+
<li class="toctree-l1"><a class="reference internal" href="/replica_cluster/">Replica clusters</a>
138+
</li>
139+
</ul>
140+
<ul>
141+
<li class="toctree-l1"><a class="reference internal" href="/kubernetes_upgrade/">Kubernetes Upgrade</a>
142+
</li>
143+
</ul>
144+
<ul>
145+
<li class="toctree-l1"><a class="reference internal" href="/expose_pg_services/">Exposing Postgres Services</a>
146+
</li>
147+
</ul>
148+
<ul>
149+
<li class="toctree-l1"><a class="reference internal" href="/cnpg-plugin/">CloudNativePG Plugin</a>
150+
</li>
151+
</ul>
152+
<ul>
153+
<li class="toctree-l1"><a class="reference internal" href="/failover/">Automated failover</a>
154+
</li>
155+
</ul>
156+
<ul>
157+
<li class="toctree-l1"><a class="reference internal" href="/troubleshooting/">Troubleshooting</a>
158+
</li>
159+
</ul>
160+
<ul>
161+
<li class="toctree-l1"><a class="reference internal" href="/fencing/">Fencing</a>
162+
</li>
163+
</ul>
164+
<ul>
165+
<li class="toctree-l1"><a class="reference internal" href="/postgis/">PostGIS</a>
166+
</li>
167+
</ul>
168+
<ul>
169+
<li class="toctree-l1"><a class="reference internal" href="/e2e/">End-to-End Tests</a>
170+
</li>
171+
</ul>
172+
<ul>
173+
<li class="toctree-l1"><a class="reference internal" href="/container_images/">Container Image Requirements</a>
174+
</li>
175+
</ul>
176+
<ul>
177+
<li class="toctree-l1"><a class="reference internal" href="/operator_capability_levels/">Operator Capability Levels</a>
178+
</li>
179+
</ul>
180+
<ul>
181+
<li class="toctree-l1"><a class="reference internal" href="/samples/">Examples</a>
182+
</li>
183+
</ul>
184+
<ul>
185+
<li class="toctree-l1"><a class="reference internal" href="/commercial_support/">Commercial support</a>
186+
</li>
187+
</ul>
188+
<ul>
189+
<li class="toctree-l1"><a class="reference internal" href="/faq/">Frequently Asked Questions (FAQ)</a>
190+
</li>
191+
</ul>
192+
<ul>
193+
<li class="toctree-l1"><a class="reference internal" href="/api_reference/">API Reference</a>
194+
</li>
195+
</ul>
196+
<ul>
197+
<li class="toctree-l1"><a class="reference internal" href="/supported_releases/">Supported releases</a>
198+
</li>
199+
</ul>
200+
<ul>
201+
<li class="toctree-l1"><a class="reference internal" href="/release_notes/">Release notes</a>
202+
</li>
203+
</ul>
204+
</div>
205+
</div>
206+
</nav>
207+
208+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
209+
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
210+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
211+
<a href="/.">CloudNativePG</a>
212+
213+
</nav>
214+
<div class="wy-nav-content">
215+
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
216+
<ul class="wy-breadcrumbs">
217+
<li><a href="/." class="icon icon-home" alt="Docs"></a> &raquo;</li>
218+
<li class="wy-breadcrumbs-aside">
219+
</li>
220+
</ul>
221+
<hr/>
222+
</div>
223+
224+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
225+
<div class="section" itemprop="articleBody">
226+
227+
228+
<h1 id="404-page-not-found">404</h1>
229+
230+
<p><strong>Page not found</strong></p>
231+
232+
233+
</div>
234+
</div><footer>
235+
236+
<hr/>
237+
238+
<div role="contentinfo">
239+
<!-- Copyright etc -->
240+
</div>
241+
242+
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
243+
</footer>
244+
245+
</div>
246+
</div>
247+
248+
</section>
249+
250+
</div>
251+
252+
<div class="rst-versions" role="note" aria-label="Versions">
253+
<span class="rst-current-version" data-toggle="rst-current-version">
254+
255+
256+
257+
</span>
258+
</div>
259+
<script>var base_url = '/';</script>
260+
<script src="/js/theme_extra.js" defer></script>
261+
<script src="/js/theme.js" defer></script>
262+
<script src="/search/main.js" defer></script>
263+
<script defer>
264+
window.onload = function () {
265+
SphinxRtdTheme.Navigation.enable(true);
266+
};
267+
</script>
268+
269+
</body>
270+
</html>

0 commit comments

Comments
 (0)