docs: full copy-edit of webHDFS page #11516
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Am making a few larger copy-edits now that I'm (very) familiar with the docs; this was one of the smaller ones that I managed to complete. This page is particularly self-encompassing, so works well as a first. It's also a great example page but had a bit of verbosity to it -- it's now considerably more concise.
Primarily in order to follow the k8s docs style guide and simplify docs to make them more approachable to all audiences
Modifications
Stylistic changes
use more direct language, per k8s style guide
use in-line links, per k8s style guide
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
address the reader as "you", per k8s style guide
replace Latin phrases, per k8s style guide
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
Semantic changes
overwrite
parameteroverwrite
depending on provider. the (newly linked) docs specify that it defaults tofalse
delegation
query param, per the linked docsVerification
Checked that all new links work, page renders.
Future Work
use-cases/
.mkdocs
, they require a plugin, so that requires an extra dep and configuration etc