Skip to content

Commit

Permalink
PBM-1430 Added about a docs page
Browse files Browse the repository at this point in the history 
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
  • Loading branch information
@nastena1606
nastena1606 committed Dec 3, 2024
1 parent dad3860 commit 18d3b64
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 9 deletions.
17 changes: 17 additions & 0 deletions docs/about-docs.md
View file
Original file line number Diff line number Diff line change
@@ -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.

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "docs/about-docs.md", "range": {"start": {"line": 3, "column": 27}}}, "severity": "WARNING"}

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

View workflow job for this annotation

GitHub Actions / vale

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

[Google.WordList] Use 'capability' or 'feature' instead of 'functionality'.
Raw output 
{"message": "[Google.WordList] Use 'capability' or 'feature' instead of 'functionality'.", "location": {"path": "docs/about-docs.md", "range": {"start": {"line": 3, "column": 99}}}, "severity": "WARNING"}

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

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"}

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

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.

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

View workflow job for this annotation

GitHub Actions / vale

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

[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": 9, "column": 35}}}, "severity": "WARNING"}

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": 96}}}, "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.
2 changes: 1 addition & 1 deletion docs/copyright.md
View file
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-2024 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": 66}}}, "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
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.

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 @@ Read [how PBM works](intro.md).

<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
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

0 comments on commit 18d3b64

Please sign in to comment.