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

Fix typos in docs #4279

Merged
merged 2 commits into from
Feb 13, 2019
Merged

Fix typos in docs #4279

merged 2 commits into from
Feb 13, 2019

Conversation

dubee
Copy link
Member

@dubee dubee commented Feb 13, 2019

Description

Spelling corrections for markdown files.

Related issue and scope

  • I opened an issue to propose and discuss this change (#????)

My changes affect the following components

  • API
  • Controller
  • Message Bus (e.g., Kafka)
  • Loadbalancer
  • Invoker
  • Intrinsic actions (e.g., sequences, conductors)
  • Data stores (e.g., CouchDB)
  • Tests
  • Deployment
  • CLI
  • General tooling
  • Documentation

Types of changes

  • Bug fix (generally a non-breaking change which closes an issue).
  • Enhancement or new feature (adds new functionality).
  • Breaking change (a bug fix or enhancement which changes existing behavior).

Checklist:

  • I signed an Apache CLA.
  • I reviewed the style guides and followed the recommendations (Travis CI will check :).
  • I added tests to cover my changes.
  • My changes require further changes to the documentation.
  • I updated the documentation where necessary.

@@ -105,7 +105,7 @@ The instructions that follow show you how to use the OpenWhisk Docker skeleton.
Notice the use of `--docker` when creating an action. Currently all Docker images are assumed
to be hosted on Docker Hub.

*Note:* It is considered best-practice for production images to be versioned via docker image tags. The absence of a tag will be treated the same as using the tag "latest", which will guarantee to pull from the registry when creating new containers. That contains the possibility of failing because pulling the image fails. For tagged images however, the system will allow a failing pull and gracefully recover it by using the image that is already locally available, making it much more resilient against Dockerhub outages etc.
*Note:* It is considered best-practice for production images to be versioned via docker image tags. The absence of a tag will be treated the same as using the tag "latest", which will guarantee to pull from the registry when creating new containers. That contains the possibility of failing because pulling the image fails. For tagged images however, the system will allow a failing pull and gracefully recover it by using the image that is already locally available, making it much more resilient against Docker Hub outages etc.
Copy link
Member

Choose a reason for hiding this comment

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

Can you reword this “Which will guarantee to pull...” and the sentence after it?

Copy link
Member Author

Choose a reason for hiding this comment

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

@rabbah, hopefully it makes a little more sense now.

@codecov-io
Copy link

codecov-io commented Feb 13, 2019

Codecov Report

Merging #4279 into master will increase coverage by 21.25%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #4279       +/-   ##
==========================================
+ Coverage   59.35%   80.6%   +21.25%     
==========================================
  Files         162     162               
  Lines        7585    7585               
  Branches      500     500               
==========================================
+ Hits         4502    6114     +1612     
+ Misses       3083    1471     -1612
Impacted Files Coverage Δ
.../org/apache/openwhisk/core/entity/EntityPath.scala 100% <0%> (+1.88%) ⬆️
...a/org/apache/openwhisk/core/entity/Parameter.scala 95.45% <0%> (+2.27%) ⬆️
.../org/apache/openwhisk/http/PoolingRestClient.scala 90% <0%> (+3.33%) ⬆️
...hisk/core/controller/actions/SequenceActions.scala 92.1% <0%> (+3.5%) ⬆️
...pache/openwhisk/core/containerpool/Container.scala 88.6% <0%> (+3.79%) ⬆️
...abase/cosmosdb/CosmosDBArtifactStoreProvider.scala 4% <0%> (+4%) ⬆️
...tainerpool/docker/DockerClientWithFileAccess.scala 96% <0%> (+4%) ⬆️
...rg/apache/openwhisk/core/entity/ExecManifest.scala 97.87% <0%> (+4.25%) ⬆️
...he/openwhisk/core/database/CouchDbRestClient.scala 87.23% <0%> (+4.25%) ⬆️
...a/org/apache/openwhisk/core/entity/TimeLimit.scala 95.45% <0%> (+4.54%) ⬆️
... and 93 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a205f8b...bc110d8. Read the comment docs.

@dubee dubee merged commit ccac7d5 into apache:master Feb 13, 2019
BillZong pushed a commit to BillZong/openwhisk that referenced this pull request Nov 18, 2019
* Fix typos in docs

* Re-word Docker paragraph
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants