Skip to content

Commit c0de7be

Browse files
docs: add frontmatter metadata required for Docusaurus migration (cloudnative-pg#9109)
This commit adds the frontmatter needed for the Docusaurus migration to all Markdown files under `docs/src`: - For main documentation files (`docs/src/*.md`): added `id`, `title`, and `sidebar_position` based on the ordering in `sidebar.js`. - For release notes (`docs/src/release_notes/**/*.md`): added `id` and `title` to all files, including those in the `old/` directory. Closes cloudnative-pg#9059 See also cloudnative-pg#8122 Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com> Signed-off-by: Anushka Saxena <anushkasaxena.1947@gmail.com> Co-authored-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
1 parent 9a354b8 commit c0de7be

Some content is hidden

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

80 files changed

+463
-9
lines changed

.wordlist-en-custom.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -934,6 +934,7 @@ imagePullPolicy
934934
imagePullSecrets
935935
imageVolume
936936
imagecatalogs
937+
imagevolume
937938
img
938939
immediateCheckpoint
939940
impactful

docs/src/appendixes/backup_barmanobjectstore.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: backup_barmanobjectstore
3+
title: Appendix B - Backup on object stores
4+
---
5+
16
# Appendix B - Backup on object stores
27

38
<!-- SPDX-License-Identifier: CC-BY-4.0 -->

docs/src/appendixes/backup_volumesnapshot.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: backup_volumesnapshot
3+
title: Appendix A - Backup on volume snapshots
4+
---
5+
16
# Appendix A - Backup on volume snapshots
27
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
38

docs/src/appendixes/object_stores.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: object_stores
3+
title: Appendix C - Common object stores for backups
4+
---
5+
16
# Appendix C - Common object stores for backups
27
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
38

docs/src/applications.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
id: applications
3+
sidebar_position: 340
4+
title: Connecting from an application
5+
---
6+
17
# Connecting from an application
28
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
39

docs/src/architecture.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
id: architecture
3+
sidebar_position: 40
4+
title: Architecture
5+
---
6+
17
# Architecture
28
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
39

docs/src/backup.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
id: backup
3+
sidebar_position: 180
4+
title: Backup
5+
---
6+
17
# Backup
28
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
39

docs/src/backup_recovery.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: backup_recovery
3+
title: Backup and Recovery
4+
---
5+
16
# Backup and Recovery
27
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
38

docs/src/before_you_start.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Before You Start
1+
---
2+
id: before_you_start
3+
sidebar_position: 20
4+
title: Before you start
5+
---
6+
7+
# Before you start
28
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
39

410
Before we get started, it is essential to go over some terminology that is

docs/src/benchmarking.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
id: benchmarking
3+
sidebar_position: 530
4+
title: Benchmarking
5+
---
6+
17
# Benchmarking
28
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
39

0 commit comments

Comments
 (0)