-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
PBM-1430 Added about a docs page #238
base: main
Are you sure you want to change the base?
Conversation
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
Outdated
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. | |
You should run the latest version of PBM to receive all bug and security fixes and benefit from the new features. For this reason, the documentation always reflects the latest PBM version. |
docs/about-docs.md
Outdated
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 take a look at the release notes for detailed information. |
|
||
## 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for willing to contribute to Percona Backup for MongoDB project. Please check the [Contribution guidelines](reference/contributig.md) for instructions. | |
Thank you for your willingness to contribute to Percona Backup for MongoDB project. Please check the [Contribution guidelines](reference/contributing.md) for instructions. |
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we use a variable here to avoid hardcoded dates in all places?
|
||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. | |
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. |
Co-authored-by: radoslawszulgo <[email protected]>
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