Skip to content

Documentation update and re-organisation#380

Merged
lildude merged 21 commits into
masterfrom
lildude/docs-update-reorg
Mar 27, 2018
Merged

Documentation update and re-organisation#380
lildude merged 21 commits into
masterfrom
lildude/docs-update-reorg

Conversation

@lildude

@lildude lildude commented Mar 26, 2018

Copy link
Copy Markdown
Member

This PR updates and re-organises the documentation.

It makes the README more readable by moving most of the content to individual files under docs/ and updates the content to be more consistent across all files and reflect the behaviour and requirements once #375 has been merged.

Most of the overall wording is the same.

/cc @github/backup-utils

@lildude lildude requested a review from a team March 26, 2018 09:54
Comment thread docs/getting-started.md

1. [Download the latest release version][1] and extract the repository using `tar`:

`tar -xzvf /path/to/github-backup-utils-vMAJOR.MINOR.PATCH.tar.gz`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

While it is mentioned in the requirements section, additional clarity around which version of the backup utilities to use if you are running GHE 2.10 or earlier would be valuable here, in particular if cloning the repository using git.

Comment thread docs/getting-started.md
`git clone -b stable https://github.com/github/backup-utils.git`

**Note**: you will need to use [backup-utils v2.11.x][2] or the `legacy` branch to
backup and restore GitHub Enterprise 2.10 and earlier.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@snh like this? ☝️

@lildude lildude mentioned this pull request Mar 27, 2018
4 tasks
Comment thread README.md Outdated
- **[How does backup utilities differ from a High Availability replica?](#how-does-backup-utilities-differ-from-a-high-availability-replica)**
- **[Support](#support)**
**Note**: the [GitHub Enterprise version requirements](docs/requirements.md#github-enterprise-version-requirements) have
changed starting with Backup Utilities v2.13.0.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should we add a date here so folks have a better sense of when this requirement changed?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good idea (for those who follow master so don't get versions).

@rubiojr rubiojr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM.

@lildude lildude merged commit 0c534ca into master Mar 27, 2018
@lildude lildude deleted the lildude/docs-update-reorg branch March 27, 2018 15:56
dooleydevin pushed a commit that referenced this pull request Jul 14, 2023
…t-always-restore-column-encryption-keys

Backport 349 for 3.8: Always restore column encryption keys
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.

4 participants