#54 Fix spelling mistakes; Merge old wiki info for GitHub workflow
Closed by jhrozek. Opened by sobek.
SSSD/ sobek/docs fix-spelling-mistakes  into  master

Download 54.patch

Resolves:
https://pagure.io/SSSD/sssd/issue/3557

Please note, at "Pushing a pull request" I changed from:

git push -n origin master
git push origin master

to:

git push -n github master
git push github master

as it matches the setup from the above sections. I hope this is alright.

I have a question for the file design_pages/auto_private_groups.rst.
In the section Overview of the solution you can read:

Most of the low-level functionality in the sysdb layer had been developed ...

has 'had been' been used intentionally? If sysdb layer is still being developed 'has been' should be used, from my point of view.

rebased onto 2c229a4b5930c5cd8ad88369aa8135e2e8ef75af

rebased onto 8b877a20e96cbfc848f9008bb4a9363da9ff8b11

Could you split it into two commits?
One with grammar fixes and another with new content.

@sobek btw how do you find the typos? If there is some aspell or similar command that is easy to run, perhaps we could amend the howto to also include this step so that everyone could check e.g. newly submitted design pages for typos.

I would like to request a small change here. Could you explicitly add that this is the preferred way?

Did you mean to say "assume you are using github" here?

In the meantime, we started using "changes requested" and "accepted" labels instead of "nack" and "ack" because they sound a bit more polite.

I left a couple of comments inline. Thank you very much for the contribution. I agree with @lslebodn it would be nice to split your commit into two, but if it's too much hassle, I could also live with a single commit.

rebased onto b734302fdb56b282b1f74536b66f01c8beb3bed1

No, because on line 113 git clone uses Pagure. I thought this file is for Pagure, the other for GitHub. Of course, both share information, hence the linking.

You are welcome.
The commits have been split in two with the help of git reset --soft HEAD~1.
The changes have been made and pushed.

@jhrozek I added the paragraph "Spell-checker" to the file developers/contribute.rst.
My workflow for finding typos is at first do a mass scan:

  • open one file with LibreOffice Writer

  • select whole text with keyboard shortcut Ctrl+A

  • at the bottom in the middle set the language to "English (USA)" (equals Tools -- Language -- For all Text -- English (USA))

  • press F7 (equals: Tools -- Spelling and Grammar ...)

  • press [Ignore Once] for known bad words; press [Ignore All] to ignore the word until LibreOffice is closed; press [Add to Dictionary] to add it to known word list

  • fix problem with command line text editor

  • in the terminal go to directory with source code; run fgrep -ri ${BADWORD} or egrep -r 'REGEXP' to find other instances of problem

  • do not close LibreOffice, open next file and check it

To follow up after mass scanning:

  • I run git log and search for the hash of my latest commit

  • then rungit diff HASH to get the changes

  • copy-Pasting the output and check it

Finding other problems, f.e. "he its" => "he is)", by careful reading.

I tried aspell in the past but could not find out how to manage dictionaries. I did not spend time to find out because LibreOffice was working for me.

2 new commits added

  • Merge old wiki info for GitHub workflow
  • Fix spelling mistakes

I'm sorry for the long wait, I pushed the patches now.

Thanks for the contribution!

Pull-Request has been closed by jhrozek

Metadata