Skip to content
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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Dec 9, 2024
Merged

PBM-1430 Added about a docs page #238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18d3b64
PBM-1430 Added about a docs page
nastena1606 Dec 3, 2024
eede266
Update docs/about-docs.md
nastena1606 Dec 4, 2024
3fdcdcb
Updated after the review
nastena1606 Dec 4, 2024
429351d
Introduced year variable'
nastena1606 Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/about-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Check warning on line 7 in docs/about-docs.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/about-docs.md#L7 

[Google.We] Try to avoid using first-person plural like 'We'.
Raw output 
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/about-docs.md", "range": {"start": {"line": 7, "column": 1}}}, "severity": "WARNING"}

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.

Check notice on line 9 in docs/about-docs.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/about-docs.md#L9 

[Google.Passive] In general, use active voice instead of passive voice ('is added').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is added').", "location": {"path": "docs/about-docs.md", "range": {"start": {"line": 9, "column": 60}}}, "severity": "INFO"}

Check notice on line 9 in docs/about-docs.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/about-docs.md#L9 

[Google.Passive] In general, use active voice instead of passive voice ('was introduced').
Raw output 
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('was introduced').", "location": {"path": "docs/about-docs.md", "range": {"start": {"line": 9, "column": 106}}}, "severity": "INFO"}

## 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).

Check failure on line 13 in docs/about-docs.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/about-docs.md#L13 

[Vale.Spelling] Did you really mean 'Jira'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'Jira'?", "location": {"path": "docs/about-docs.md", "range": {"start": {"line": 13, "column": 155}}}, "severity": "ERROR"}

## 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.
nastena1606 marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion docs/copyright.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Check notice on line 5 in docs/copyright.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/copyright.md#L5 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/copyright.md", "range": {"start": {"line": 5, "column": 45}}}, "severity": "INFO"}

Check notice on line 5 in docs/copyright.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/copyright.md#L5 

[Google.Acronyms] Spell out 'LLC', if it's unfamiliar to the audience.
Raw output 
{"message": "[Google.Acronyms] Spell out 'LLC', if it's unfamiliar to the audience.", "location": {"path": "docs/copyright.md", "range": {"start": {"line": 5, "column": 70}}}, "severity": "INFO"}
and is distributed under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/) license.
15 changes: 8 additions & 7 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
nastena1606 marked this conversation as resolved.
Show resolved Hide resolved

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
Expand All @@ -22,7 +23,7 @@

<div data-grid markdown><div data-banner markdown>

## :material-progress-download: Installation guides { .title }
### :material-progress-download: Installation guides { .title }

Check warning on line 26 in docs/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/index.md#L26 

[Google.Headings] ':material-progress-download: Installation guides { .title }' should use sentence-style capitalization.
Raw output 
{"message": "[Google.Headings] ':material-progress-download: Installation guides { .title }' should use sentence-style capitalization.", "location": {"path": "docs/index.md", "range": {"start": {"line": 26, "column": 5}}}, "severity": "WARNING"}

Ready to try out PBM? Get started quickly with the step-by-step installation instructions.

Expand Down
3 changes: 2 additions & 1 deletion mkdocs-base.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions variables.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

release: '2.7.0'
version: '2.7'
year: '2024'

date:
2_6_0: 2024-09-02
Expand Down
Loading