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.

Sign up for GitHub

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

Jump to bottom

Removed future tense from docs content #6646

Merged
merged 10 commits into from
Oct 20, 2021
Merged

Removed future tense from docs content #6646

merged 10 commits into from
Oct 20, 2021

Conversation

ricklarsen
Copy link

What does this PR do?

edits to documentation to standardize present tense usage over future tense.
This aligns with the Google Developer Documentation Style Guide guidance: https://developers.google.com/style/tense?hl=en

Who is reviewing it?

@shaundmorris
@jaymcnallie
@rececoffin
@sgalla
@ahoffer

Select relevant component teams:

@codice/docs

How should this be tested?

review content.

Checklist:

  • Documentation Updated
  • Update / Add Threat Dragon models
  • Update / Add Unit Tests
  • Update / Add Integration Tests

Notes on Review Process

Please see Notes on Review Process for further guidance on requirements for merging and abbreviated reviews.

Review Comment Legend:

  • ✏️ (Pencil) This comment is a nitpick or style suggestion, no action required for approval. This comment should provide a suggestion either as an in line code snippet or a gist.
  • ❓ (Question Mark) This comment is to gain a clearer understanding of design or code choices, clarification is required but action may not be necessary for approval.
  • ❗ (Exclamation Mark) This comment is critical and requires clarification or action before approval.

@ricklarsen ricklarsen force-pushed the doc-edits-future branch 2 times, most recently from c326a36 to 2154d6a Compare October 19, 2021 19:28
ahoffer
ahoffer approved these changes Oct 19, 2021
View reviewed changes
Copy link
Contributor

@ahoffer ahoffer left a comment

Choose a reason for hiding this comment

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

Yeah! This is a great change. It is pithier and easier to understand.

Native English speakers do not realize how many tenses the English language has.
https://www.myenglishpages.com/english/grammar-lesson-how-many-tenses-are-there-in-english.php

@ricklarsen
Copy link
Author

build now

@cxddfbot
Copy link

Internal build has been started, your results will be available at build completion.

@cxddfbot
Copy link

Build SUCCESS See the job results in legacy Jenkins UI or in Blue Ocean UI.

@ricklarsen ricklarsen merged commit effa3c7 into codice:2.26.x Oct 20, 2021
@ricklarsen ricklarsen deleted the doc-edits-future branch October 20, 2021 17:40
ricklarsen pushed a commit to ricklarsen/ddf that referenced this pull request Oct 20, 2021
Removed future tense from docs content (codice#6646)
4e45de0 
* removed future tense from docs content

* removed future tense from developing docs

* removed future tense from integrating docs

* removed future tense from introduction docs

* removed future tense from managing docs

* removed future tense from metadata reference docs

* removed future tense from quick start docs

* removed future tense from reference docs

* removed future tense from using docs

* Copy edits docs content
@ricklarsen ricklarsen mentioned this pull request Oct 20, 2021
Merged
4 tasks
ricklarsen pushed a commit to ricklarsen/ddf that referenced this pull request Nov 2, 2021
Removed future tense from docs content (codice#6646)
6823dd4 
* removed future tense from docs content

* removed future tense from developing docs

* removed future tense from integrating docs

* removed future tense from introduction docs

* removed future tense from managing docs

* removed future tense from metadata reference docs

* removed future tense from quick start docs

* removed future tense from reference docs

* removed future tense from using docs

* Copy edits docs content
ricklarsen pushed a commit that referenced this pull request Nov 2, 2021
Removed future tense from docs content (#6646)
7e06704 
* removed future tense from docs content

* removed future tense from developing docs

* removed future tense from integrating docs

* removed future tense from introduction docs

* removed future tense from managing docs

* removed future tense from metadata reference docs

* removed future tense from quick start docs

* removed future tense from reference docs

* removed future tense from using docs

* Copy edits docs content
ricklarsen pushed a commit that referenced this pull request Nov 2, 2021
Removed future tense from docs content (#6646)
b24e513 
* removed future tense from docs content

* removed future tense from developing docs

* removed future tense from integrating docs

* removed future tense from introduction docs

* removed future tense from managing docs

* removed future tense from metadata reference docs

* removed future tense from quick start docs

* removed future tense from reference docs

* removed future tense from using docs

* Copy edits docs content
ricklarsen pushed a commit that referenced this pull request Nov 3, 2021
Removed future tense from docs content (#6646) (#6651)
adaacf8 
* removed future tense from docs content

* removed future tense from developing docs

* removed future tense from integrating docs

* removed future tense from introduction docs

* removed future tense from managing docs

* removed future tense from metadata reference docs

* removed future tense from quick start docs

* removed future tense from reference docs

* removed future tense from using docs

* Copy edits docs content
alexabird added a commit that referenced this pull request Aug 8, 2024
@alexabird
Revert "Removed future tense from docs content (#6646)"
b141df6 
This reverts commit effa3c7.
alexabird added a commit that referenced this pull request Sep 13, 2024
@alexabird
Revert "Removed future tense from docs content (#6646)"
8f96b45 
This reverts commit effa3c7.
alexabird added a commit that referenced this pull request Sep 13, 2024
@alexabird
Revert "Removed future tense from docs content (#6646)"
a8a9976 
This reverts commit effa3c7.
@malmgrens4 malmgrens4 mentioned this pull request Oct 31, 2024
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pklinef pklinef pklinef approved these changes

@ahoffer ahoffer ahoffer approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ricklarsen @cxddfbot @ahoffer @pklinef