Skip to content

GEODE-7955: Docs for redundancy internal API and redundancy commands#5005

Merged
DonalEvans merged 2 commits intoapache:developfrom
DonalEvans:RestoreRedundancyDocs
May 1, 2020
Merged

GEODE-7955: Docs for redundancy internal API and redundancy commands#5005
DonalEvans merged 2 commits intoapache:developfrom
DonalEvans:RestoreRedundancyDocs

Conversation

@DonalEvans
Copy link
Contributor

@DonalEvans DonalEvans commented Apr 27, 2020

  • Document restore redundancy gfsh command
  • Document status redundancy gfsh command
  • Document new RestoreRedundancyOperation API usage
  • Add rebalance and restore redundancy stats to stats list
  • Removed suggestion to use show metrics command to determine redundancy
    status
  • Removed suggestions to use rebalance when only restoring redundancy is
    wanted

Authored-by: Donal Evans doevans@pivotal.io

Thank you for submitting a contribution to Apache Geode.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced in the commit message?

  • Has your PR been rebased against the latest commit within the target branch (typically develop)?

  • Is your initial contribution a single, squashed commit?

  • Does gradlew build run cleanly?

  • [N/A] Have you written or updated unit tests to verify your changes?

  • [N/A] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?

Note:

Please ensure that once the PR is submitted, check Concourse for build issues and
submit an update to your PR as soon as possible. If you need help, please send an
email to dev@geode.apache.org.

- Document restore redundancy gfsh command
- Document status redundancy gfsh command
- Document new RestoreRedundancyOperation API usage
- Add rebalance and restore redundancy stats to stats list
- Removed suggestion to use show metrics command to determine redudancy
status
- Removed suggestions to use rebalance when only restoring redundancy is
wanted

Authored-by: Donal Evans <doevans@pivotal.io>
Copy link
Contributor

@davebarnes97 davebarnes97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Editorial suggestions.

  • In geode-subnav.erb:

href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/restore.html">restore

Make the topic "restore redundancy" (this follows a convention already in use)

  • In checking_region_redundancy.html.md.erb:

"First, starting a gfsh prompt and connect..." should be "Start gfsh and connect..."

  • In rebalancing_pr_data.html.md.erb:

Rebalancing solely for the purpose of restoring lost redundancy in the
case that redundancy is being used for high availability and the
region has been configured to not automatically recover redundancy
after a loss is not necessary.

Reword slightly and add commas:

Rebalancing solely for the purpose of restoring lost redundancy, when
redundancy is being used for high availability and the
region has been configured to not automatically recover redundancy
after a loss, is not necessary.

  • In restoring_region_redundancy.html.md.erb:

Paragraph 2:

"Restoring redundancy will create new redundant copies..."
"It will not move buckets..."

Rephrase these sentences from future to present tense:

"Restoring redundancy creates new redundant copies..."
"It does not move buckets..."

  • In restore.html.md.erb:

behaviour -> behavior

  • In status.html.md.erb:

Add an entry for the newly-added "status redundancy" topic to the bullet list at the top of the page. (follow format of other entries)

Authored-by: Donal Evans <doevans@pivotal.io>
@DonalEvans DonalEvans requested a review from davebarnes97 May 1, 2020 02:49
Copy link
Contributor

@davebarnes97 davebarnes97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 LGTM

@DonalEvans DonalEvans merged commit a820c59 into apache:develop May 1, 2020
@DonalEvans DonalEvans deleted the RestoreRedundancyDocs branch May 1, 2020 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants