Skip to content

Fix typos in training documentation - #4

Open
Avicennasis wants to merge 1 commit into
adidas:masterfrom
Avicennasis:bugfix/fix-typos-in-documentation
Open

Avicennasis wants to merge 1 commit into
adidas:masterfrom
Avicennasis:bugfix/fix-typos-in-documentation

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fixes 20 spelling and grammar typos found while reading through the training
material. Documentation only - no changes to the training content or its meaning.

README.md

  • The instructor welcome the students -> welcomes (subject/verb agreement)
  • explaining how would they do it -> how they would do it (indirect question order)
  • each team would expose how would they proceed -> how they would proceed
  • for different purposes that the ones described -> than the ones described

instructor/module-01.md

  • Therefor we need to measure -> Therefore
  • therefor it makes sense to elaborate -> therefore
  • the use case that allows to check whether -> allows checking whether

instructor/module-02.md

  • heading ### Come with the initial go-live strategy -> ### Come up with the initial go-live strategy

instructor/module-03.md

  • With the MVP implement, deployed -> implemented

instructor/module-04.md

  • to a increasing number of clients -> an increasing
  • What communication channel are going to make available -> What communication channels are we going to make available

instructor/module-07.md

  • Be very clear on what do they need to do -> what they need to do

instructor/module-08.md

  • different SLA agreement with different clients -> agreements
  • below reponse time Threshold -> response

instructor/module-09.md

  • the continuously evolving the API -> the continuously evolving API (duplicated article)
  • clients that refuse the migrate -> refuse to migrate
  • one of the possible approach how to handle -> one of the possible approaches to handle

student/module-01.md

  • issues or complains around deliveries -> complaints

matrix.md

  • Monitor de transition -> Monitor the transition
  • Dimensions of sucess -> success
  • row 2 Come with the initial go-live strategy -> Come up with ... to stay in sync with the module-02 heading above

Two hunks worth a closer look:

  • The module-02 heading change alters its generated anchor slug
    (#come-with-the-initial-go-live-strategy -> #come-up-with-...). Happy to drop
    that hunk (and the matching matrix.md row) if you would rather keep the anchor stable.
  • instructor/module-04.md line 32 needed a subject as well as the plural, so it reads
    What communication channels are we going to make available, matching the
    How are we going to ... bullets around it.

Branch name and commit message follow the adidas contribution guidelines
(bugfix/ kebab-case branch, infinitive-verb commit title under 40 chars).

Correct 20 spelling and grammar errors across the README, matrix and
instructor/student module documents. Documentation only, no changes to
training content or meaning.
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.

1 participant