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.

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

Create restic.md #10

Merged
merged 2 commits into from Sep 10, 2019
Merged

Create restic.md #10

merged 2 commits into from Sep 10, 2019

Conversation

Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
@jdrch
Copy link
Contributor

@jdrch jdrch commented Sep 9, 2019

This guide contains thorough details on how to set up restic on Trident, including environment variable and password file creation.

This guide contains thorough details on how to set up restic on Trident, including environment variable and password file creation.
@q5sys
Copy link
Member

@q5sys q5sys commented Sep 9, 2019

Looks good to me, though I'd like Tim to give the grammar a once over when he's got time.

@q5sys q5sys requested a review from Mrt134 Sep 9, 2019
@jdrch
Copy link
Contributor Author

@jdrch jdrch commented Sep 9, 2019

I typically update my guides for grammar, syntax, etc. in multiple iterations after the 1st pull request is approved. You can take a look at the history of zfsnap.md (the zfsnap guide I wrote) to see what I mean.

Mrt134
Mrt134 approved these changes Sep 9, 2019
Copy link
Contributor

@Mrt134 Mrt134 left a comment

Thanks for submitting this guide! I did a quick review of the text and have a couple suggestions to improve readability in future revisions:

  • Avoid parenthetical asides when possible. These tend to interrupt sentence flow and can be confusing for the reader.
  • Complex sentences joined by multiple comma clauses can be difficult to understand. The reader might find it helpful when long or complicated thoughts are broken down into smaller sentences.

@jdrch
Copy link
Contributor Author

@jdrch jdrch commented Sep 9, 2019

couple suggestions

Thanks!

Avoid parenthetical asides when possible

OK. How do you suggest I make points that I prefer to be located close to each other?

Personally, I prefer all sequential aspects of a particular feature relevant to my use of it to at least be simultaneously visible. For example: if A, B, and C are useful to know for Step 1 of something, I'd prefer that A, B, and C are simultaneously visible within Step 1. This is one of the reasons I struggle heavily with manpages in general. The A, B, and C analogs tend to be VERY far apart, and so it takes me hours to mentally construct what I need to do. It's the entire reason I started writing guides 😉.

The reader might find it helpful when long or complicated thoughts are broken down into smaller sentences

I'll run through what I wrote and try to reduce these. Thanks.

I should add that my guides are meant to complement existing official documentation for functions and features, not supplant or replace them.

Cut some extraneous sentences and words. Reduced sentence length and minimized the use of parentheses.
@jdrch jdrch closed this Sep 9, 2019
@jdrch jdrch reopened this Sep 9, 2019
@Mrt134
Copy link
Contributor

@Mrt134 Mrt134 commented Sep 10, 2019

For parentheticals, I generally try to restructure the sentence or paragraph. For example,

An example of a crontab schedule is `0	14	*	*	*` (tab separated), which translates to:

can be reworked to include the aside and any other important details about crontab schedules as a supporting sentence:

Crontab schedules consist of five numeric or asterisk `*` values separated by tabs. For example, `0	14	*	*	*` translates to:

or

An example crontab schedule is `0	14	*	*	*`. Each value is separated by a tab. This schedule translates to:

All that aside, I reviewed the latest changes and the PR looks fine, so I'm going to go ahead and merge the PR. Thanks again for writing and submitting this guide!

@Mrt134 Mrt134 merged commit 7d6a1b9 into project-trident:master Sep 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment