#34 review of the new project-tracking doc
Closed by ppisar. Opened by langdon.
fedora-docs/ langdon/modularity review-of-project-tracking  into  master

Download 34.patch
  • introduced line breaks per sentence (per recommendation from docs people)
  • grammar clean up
  • language clean up
  • minor content addition pointing out 'cards are not docs'

Splitting these into multiple commits would make it easier to review.

I'll take a look.

"show"?

Why the emphasis?

"…tracked on a…" should be "…tracked on the…"

Same here, "…collected in a…" should be "…collected in the…"

Same indefinite vs. definite pronoun thing plus I'd avoid the gerund here. E.g.: "To set the direction of the project."

"To define actionable…"

"Tiaga" → "Taiga"

I'd drop "already" in this sentence.

Is there a way to phrase this without doing "… progress … progress …"? This sounds tautological to me.

@langdon, let me know if you want a hand in splitting the changes up (as per the bullets in your first comment).

@langdon, let me know if you want a hand in splitting the changes up (as per the bullets in your first comment).

personally, I would just merge the change, then do another set of edits. Perhaps we could do the "line breaking on periods" part as one commit then language changes after. However, as it is just text, I am not sure how important commit history is. Let me know your ( @nphilipp, @psabata, @asamalik ) preference(s), im happy to do either, but that is my opinion.

Fine with me to merge and change on top (though I have to ignore my pedantry gland a little there :wink:).

Thanks @langdon for the PR and thanks others for suggestions. From my side:

  • +1 introduced line breaks per sentence (per recommendation from docs people)
  • +1 grammar clean up
  • +1 language clean up
  • -1 minor content addition pointing out 'cards are not docs' — My thinking: if the card isn't about writing documentation, there is no documentation. It doesn't apply in general. Also, that page should be as short as possible — it's basically a cheat sheet. Other pages with more details are coming.

@langdon So I propose, on top of the feedback above, we only keep the new lines and grammar checks.

BTW The "one sentence per line" rule is to make change reviews easier. In this case, it kind of worked the opposite way, because that was the change + grammar + language + content changes, all in a single commit. So everything looks changed.

I'm sorry but it seems that none of the edited sentence exists in the current documentation. I will close this pull request without merging.

Pull-Request has been closed by ppisar

Metadata