Skip to content

Conversation

@steveperry-53
Copy link
Contributor

@steveperry-53 steveperry-53 commented Jan 21, 2018

This PR fixes a few mistakes in the Kubernetes API reference docs.

For example, in the currently published reference docs, under Toleration, the description is missing some place holders that are in angle brackets.

The description should say this:

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

But instead, is says this:

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Preview of updated ref docs

This PR is not a direct update to the generated HTML file. The HTML file in this PR was generated after I made revisions to the generation code at kubernetes-incubator/reference-docs.


This change is Reviewable

@steveperry-53 steveperry-53 self-assigned this Jan 21, 2018
@k8s-ci-robot k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Jan 21, 2018
@steveperry-53 steveperry-53 added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 21, 2018
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jan 21, 2018
@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented Jan 21, 2018

Deploy preview for kubernetes-io-master-staging ready!

Built with commit abe95bf

https://deploy-preview-7038--kubernetes-io-master-staging.netlify.com

@steveperry-53 steveperry-53 removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 24, 2018
@steveperry-53
Copy link
Contributor Author

/assign @zacharysarah
/cc @abiogenesis-now
/cc @chenopis

@steveperry-53
Copy link
Contributor Author

@misterikkit

@steveperry-53 steveperry-53 changed the title Resotre escape sequences in descriptions. Replace angle brackets with HTML entities. Jan 24, 2018
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 24, 2018
@steveperry-53 steveperry-53 added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 24, 2018
@steveperry-53 steveperry-53 changed the title Replace angle brackets with HTML entities. Replace regular characters with HTML entities. Jan 24, 2018
@zacharysarah
Copy link
Contributor

👍 🚢

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 24, 2018
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: steveperry-53, zacharysarah

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these OWNERS Files:
  • OWNERS [steveperry-53,zacharysarah]

You can indicate your approval by writing /approve in a comment
You can cancel your approval by writing /approve cancel in a comment

@steveperry-53 steveperry-53 removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 26, 2018
@k8s-ci-robot k8s-ci-robot merged commit e1cbd8b into kubernetes:master Jan 26, 2018
chenopis added a commit that referenced this pull request Jan 29, 2018
…henopis-user-journeys

* 'master' of https://github.com/kubernetes/website: (102 commits)
  Change deployment group (#7112)
  fix typos in extending doc (#7110)
  added installation via Powershell Gallery (#6086)
  Update StatefulSet API version to 1.9 for the Cassandra example (#7096)
  Modify the terms by document style (#7026)
  now that phase out in k8s/cluster/ directory, so remove relative docs (#6951)
  Update mysql-wordpress-persistent-volume.md (#7080)
  Update high-availability.md (#7086)
  Feature gates reference documentation (#6364)
  Add link to autoscaler FAQ (#7045)
  Replace regular characters with HTML entities. (#7038)
  Remove unnecessary manual node object creation (#6765)
  upper case restriction doesn't exist (#7003)
  Add an API concepts document and describe terminology and API chunking (#6540)
  Add kube-apiserver, kube-controller-manager, kube-scheduler and etcd to glossary. (#6600)
  Update what-is-kubernetes.md (#6971)
  Fixed the interacting with cluster section for the ubuntu installation (#6905)
  Update weave-network-policy.md (#6960)
  Added AWS eks (#6568)
  Update eviction strategy to include priority (#6949)
  ...

# Conflicts:
#	_data/setup.yml
#	_data/tutorials.yml
#	docs/imported/release/notes.md
@steveperry-53 steveperry-53 deleted the ref-fix branch January 31, 2018 18:34
bitfield pushed a commit to bitfield/website that referenced this pull request Feb 19, 2018
* Add HTML entities.

* Use entities in field descriptions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants