diff --git a/docs/about-docs.md b/docs/about-docs.md new file mode 100644 index 00000000..1911597d --- /dev/null +++ b/docs/about-docs.md @@ -0,0 +1,17 @@ +# About Percona Backup for MongoDB documentation + +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 + +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 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 + +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..c1da55d7 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-{{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/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).