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

Tweak glossary entry for Static Pod #15731

Closed

Conversation

sftim
Copy link
Contributor

@sftim sftim commented Aug 8, 2019

Prompted by a comment on #13831, I wonder if this change will help the glossary entry come out right.

  • fix date of entry
  • fix link to page
  • drop Hugo shortcodes

Using glossary tooltips in glossary entries seems both:

  • helpful to readers
  • a bit fragile, because I have seen some implementation snags that surprised me

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 8, 2019
@sftim sftim changed the title [WIPTweak glossary entry for Static Pod [WIP] Tweak glossary entry for Static Pod Aug 8, 2019
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 8, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign steveperry-53
You can assign the PR to them by writing /assign @steveperry-53 in a comment when ready.

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

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@netlify
Copy link

netlify bot commented Aug 8, 2019

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

Built with commit 62ff0f0

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

@@ -10,5 +10,4 @@ aka:
tags:
- fundamental
---
A {{< glossary_tooltip text="pod" term_id="pod" >}} managed directly by the kubelet
daemon on a specific node, without the API server observing it.
A Pod managed directly by the kubelet on a specific node, without the API server controlling it.
Copy link
Contributor

Choose a reason for hiding this comment

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

hi @sftim. Did you get a clean, local build?
The preview looks like the other, correct previews in the past -- the Mirror Pod and Static Pod entries are in the glossary. Should the full_link field point to the new location for static-pod?
Question:
What happened to the glossary entries for Mirror Pod and Static Pod on the current kubernetes.io site?
What happened to the static-pod page when moved from tasks/administer-cluster to tasks/configure-pod-container/static-pod.md? It is odd that the preview is okay, but the site is not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Netlify built the PR and the preview looks OK, so that's enough to convince me. I didn't try this locally.

Good spot about the full_link:, I'll fix that.

Copy link
Contributor

Choose a reason for hiding this comment

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

Would you have time to try and build locally -- I am really curious about the build failure 😃

Copy link
Contributor Author

Choose a reason for hiding this comment

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

make docker-serve starts fine locally for this branch, and for master

Copy link
Contributor

@kbhawkey kbhawkey Aug 8, 2019

Choose a reason for hiding this comment

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

👍 My local build is fine -- except for the mirror pod issue in the new static-pod file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the mirror pod issue in the new static-pod file.
What issue is that @kbhawkey ? (I'm mostly concentrating elsewhere, sorry)

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi! I did a bit of testing. Lines 13 and 14 seem fine in my local hugo build (docker or hugo server). The date in static-pod and mirror-pod seem to cause an error.
See #15752.

- fix date of entry
- fix link to page
- drop Hugo shortcodes
@sftim sftim force-pushed the 20190808_static_pod_glossary_tweak branch from e682f1d to 62ff0f0 Compare August 8, 2019 12:21
@sftim
Copy link
Contributor Author

sftim commented Aug 8, 2019

The date was wrong too: e682f1d#diff-c5154bb7feb1eb1e27a9265dff2c1257R4

@sftim sftim changed the title [WIP] Tweak glossary entry for Static Pod Tweak glossary entry for Static Pod Aug 8, 2019
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 8, 2019
@poothia
Copy link
Contributor

poothia commented Aug 8, 2019

lgtm

@sftim
Copy link
Contributor Author

sftim commented Aug 9, 2019

Superseded by #15752

@sftim sftim closed this Aug 9, 2019
@sftim sftim deleted the 20190808_static_pod_glossary_tweak branch August 9, 2019 05:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants