Skip to content

Commit fc0975b

Browse files
authored
docs: remove old documentation source code (#400)
Signed-off-by: Leonardo Cecchi <[email protected]>
1 parent af52f1a commit fc0975b

File tree

4,904 files changed

+8
-1498391
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

+8
-1498391
lines changed

README.md

Lines changed: 8 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -75,58 +75,14 @@ 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 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).
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).
13086

13187
## Publishing on the website
13288

archetypes/docs.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

assets/documentation/1.15.0/index.html

Lines changed: 0 additions & 11 deletions
This file was deleted.

assets/documentation/1.15.1/index.html

Lines changed: 0 additions & 11 deletions
This file was deleted.

assets/documentation/1.15/404.html

Lines changed: 0 additions & 270 deletions
This file was deleted.

0 commit comments

Comments
 (0)