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

docs: full copy-edit of webHDFS page #11516

Merged
merged 2 commits into from
Aug 14, 2023

Commits on Aug 3, 2023

  1. docs: full copy-edit of webHDFS page

    Stylistic changes:
    - use more direct language, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language)
      - "Using webHDFS protocol via HTTP artifacts" -> "webHDFS via HTTP artifacts"
      - "In order to use [...] we will make use of" -> "You can use"
      - "HTTP URL" -> "URL"
        - also consistently use the term "query paramter" instead of "HTTP URL parameter", which is ambiguous (path params, query params, etc)
      - "need to append" -> "append"
      - "This results in the following URL" -> "The result is"
      - "Now, when run, the workflow will" -> "The workflow will"
      - "There are some additional fields that can be set" -> "Additional fields can be set"
      - "In order to declare" -> "To delcare"
      - "need to change [...] to" -> "instead use"
      - "where we want the [...] to be stored" -> "your desired location"
      - "want to store the artifact under" -> "artifact will be stored at"
      - "also supply the optional overwrite [...] to allow [...]" -> "can overwrite [...] with"
      - "may want to provide some authentication option" -> "may want to use authentication"
      - "a usage of [...] can be realized by supplying" -> "can be used via"
      - several other more complex / multi-sentence simplifications
    
    - use in-line links, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#links)
    - consistently use "the full webHDFS example" when referring to the main example (instead of differing descriptions for the same example)
    
    - remove "all you need", "little change", "only", etc per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#avoid-words-that-assume-a-specific-level-of-understanding)
    - address the reader as "you", per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#address-the-reader-as-you)
    - replace Latin phrases, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#avoid-latin-phrases)
    
    - move "Additional fields" sentence to after the in-line example, as the example does not use those and it is a side note
    - comment out elipses in code blocks so that they are more copyable / valid syntax
    - use an infobox instead of "**Limitation**:" to be consistent with the rest of the docs
    
    - minor grammatical fixes
      - extra commas, extra articles, etc
    
    Semantic changes:
    - add links to HTTP artifacts and the `overwrite` parameter
      - remove note about `overwrite` depending on provider. the (newly linked) docs specify that it defaults to `false`
    - clarify the difference between Hadoop native auth and provider dependent auth
      - specify that tokens are used via the `delegation` query param, per the linked docs
    
    Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
    agilgur5 committed Aug 3, 2023
    Configuration menu
    Copy the full SHA
    f1e9028 View commit details
    Browse the repository at this point in the history

Commits on Aug 14, 2023

  1. Configuration menu
    Copy the full SHA
    61e1e58 View commit details
    Browse the repository at this point in the history