From 18d3b6459c44b4eb70b73c89ac809712d2882059 Mon Sep 17 00:00:00 2001 From: Anastasia Alexadrova Date: Tue, 3 Dec 2024 12:38:02 +0100 Subject: [PATCH 1/4] PBM-1430 Added about a docs page Documented the message that docs reflect the latest version new file: docs/about-docs.md modified: docs/copyright.md modified: docs/index.md modified: mkdocs-base.yml --- docs/about-docs.md | 17 +++++++++++++++++ docs/copyright.md | 2 +- docs/index.md | 15 ++++++++------- mkdocs-base.yml | 3 ++- 4 files changed, 28 insertions(+), 9 deletions(-) create mode 100644 docs/about-docs.md diff --git a/docs/about-docs.md b/docs/about-docs.md new file mode 100644 index 00000000..bc638099 --- /dev/null +++ b/docs/about-docs.md @@ -0,0 +1,17 @@ +# About Percona Backup for MongoDB documentation + +In this documentation you will find comprehensive information about the features, operations, and functionality of Percona Backup for MongoDB (PBM). Also reference materials on PBM commands and configuration file options are available for you here. + +## Versions + +We encourage our users to run the latest version of PBM so that they receive all bug fixes and can enjoy all new features and improvements available with the latest version. For this reason, the documentation always reflects the latest PBM version. + +To track the changes in features, we indicate the version where a feature appeared or a change was introduced. Check the release notes for detailed information. + +## Report an issue or request a change + +To report an issue with the documentation, leave your feedback using the widget at the bottom of the page or open a ticket in [Percona Backup for MongoDB Jira project :octicons-link-external-16:](https://perconadev.atlassian.net/jira/software/c/projects/PBM/issues). + +## How to contribute + +Thank you for willing to contribute to Percona Backup for MongoDB project. Please check the [Contribution guidelines](reference/contributig.md) for instructions. diff --git a/docs/copyright.md b/docs/copyright.md index 9bc1d1c2..ec570626 100644 --- a/docs/copyright.md +++ b/docs/copyright.md @@ -2,5 +2,5 @@ ## Documentation licensing -Percona Backup for MongoDB documentation is (C)2016-2023 Percona LLC and/or its affiliates +Percona Backup for MongoDB documentation is (C)2016-2024 Percona LLC and/or its affiliates and is distributed under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/) license. diff --git a/docs/index.md b/docs/index.md index 62580391..3cf2dc07 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,19 +1,20 @@ # Percona Backup for MongoDB documentation -Percona Backup for MongoDB (PBM) is an open source and distributed solution for consistent backups and restores of [MongoDB sharded clusters and replica sets](details/deployments.md) to a specific point in time. Check [supported MongoDB versions](details/versions.md). +!!! note "" + + This is the documentation for the latest release, **PBM {{release}}** ([Release Notes](release-notes/{{release}}.md)). + +Percona Backup for MongoDB (PBM) is an open source and distributed solution for consistent backups and restores of [MongoDB sharded clusters and replica sets](details/deployments.md) to a specific point in time. Here's how you can make backups on a running server and/or restore your database to a specific point in time: * using the [PBM command line interface](reference/pbm-commands.md). * from a web interface [with PBM and Percona Monitoring and Management :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/get-started/backup/index.html). -Read [how PBM works](intro.md). +Read [how PBM works](intro.md). Check [supported MongoDB versions](details/versions.md). -!!! note "" - - This is the documentation for the latest release, **PBM {{release}}** ([Release Notes](release-notes/{{release}}.md)). -## What's in it for you? +## Why to choose PBM? * Data consistency across clusters and replica sets with [every supported backup type](features/backup-types.md) * No notable performance nor operating degradation associated with PBM @@ -22,7 +23,7 @@ Read [how PBM works](intro.md).
-## :material-progress-download: Installation guides { .title } +### :material-progress-download: Installation guides { .title } Ready to try out PBM? Get started quickly with the step-by-step installation instructions. diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 79bfef66..5ac7aa5a 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -256,7 +256,8 @@ nav: - reference/pitr-options.md - reference/backup-options.md - reference/restore-options.md - - reference/glossary.md + - reference/glossary.md + - about-docs.md - reference/contributing.md - Copyright and licensing: copyright.md - Trademark policy: trademark-policy.md From eede2667f9e67044cfa5b7db32ba0d85f76494f7 Mon Sep 17 00:00:00 2001 From: Anastasia Alexandrova Date: Wed, 4 Dec 2024 17:46:08 +0100 Subject: [PATCH 2/4] Update docs/about-docs.md Co-authored-by: radoslawszulgo --- docs/about-docs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about-docs.md b/docs/about-docs.md index bc638099..84df5644 100644 --- a/docs/about-docs.md +++ b/docs/about-docs.md @@ -1,6 +1,6 @@ # About Percona Backup for MongoDB documentation -In this documentation you will find comprehensive information about the features, operations, and functionality of Percona Backup for MongoDB (PBM). Also reference materials on PBM commands and configuration file options are available for you here. +This documentation provides comprehensive information about the features and operation guide for Percona Backup for MongoDB (PBM). Reference materials on PBM commands and configuration file options are also available here. ## Versions From 3fdcdcba1993946215a2840f04e585696ba37a2e Mon Sep 17 00:00:00 2001 From: Anastasia Alexadrova Date: Wed, 4 Dec 2024 17:48:44 +0100 Subject: [PATCH 3/4] Updated after the review --- docs/about-docs.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/about-docs.md b/docs/about-docs.md index 84df5644..1911597d 100644 --- a/docs/about-docs.md +++ b/docs/about-docs.md @@ -4,9 +4,9 @@ This documentation provides comprehensive information about the features and ope ## Versions -We encourage our users to run the latest version of PBM so that they receive all bug fixes and can enjoy all new features and improvements available with the latest version. For this reason, the documentation always reflects the latest PBM version. +We recommend you to run the latest version of PBM to receive all bug fixes and benefit from the new features. For this reason, the documentation always reflects the latest PBM version. -To track the changes in features, we indicate the version where a feature appeared or a change was introduced. Check the release notes for detailed information. +To track feature changes, an additional version indication is added where a feature appeared or a change was introduced. Please also take a look at the release notes for detailed information. ## Report an issue or request a change From 429351dc58dff876960e5bac9f52dd006f18dcea Mon Sep 17 00:00:00 2001 From: Anastasia Alexadrova Date: Mon, 9 Dec 2024 15:41:51 +0100 Subject: [PATCH 4/4] Introduced year variable' --- docs/copyright.md | 2 +- variables.yml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/copyright.md b/docs/copyright.md index ec570626..c1da55d7 100644 --- a/docs/copyright.md +++ b/docs/copyright.md @@ -2,5 +2,5 @@ ## Documentation licensing -Percona Backup for MongoDB documentation is (C)2016-2024 Percona LLC and/or its affiliates +Percona Backup for MongoDB documentation is (C)2016-{{year}} Percona LLC and/or its affiliates and is distributed under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/) license. diff --git a/variables.yml b/variables.yml index 11f9b141..0234edae 100644 --- a/variables.yml +++ b/variables.yml @@ -3,6 +3,7 @@ release: '2.7.0' version: '2.7' +year: '2024' date: 2_6_0: 2024-09-02