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.

Sign up for GitHub

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

Jump to bottom

Describe {{< codenew >}} shortcode in style guide #18231

Closed
sftim opened this issue Dec 22, 2019 · 24 comments
Closed

Describe {{< codenew >}} shortcode in style guide #18231

sftim opened this issue Dec 22, 2019 · 24 comments
Assignees
@dipesh-rawat
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. language/en Issues or PRs related to English language lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@sftim
Copy link
Contributor

sftim commented Dec 22, 2019 •
edited
Loading

This is a Feature Request

What would you like to be added
In the style guide, explain when to make code samples (eg manifests) downloadable, and how to do that.

Why is this needed
https://kubernetes.io/docs/contribute/style/style-guide/ does not mention how to style downloadable code blocks.
If you know what to search for I think it's easy to work out the convention. Essentially, pages that provide ready-to-run sample manifests should put them in (eg) content/en/examples/debug/counter-pod.yaml (for English localization) and reference the downloadable code sample directly, using the
{{< codenew >}} shortcode.

Comments

For example: https://kubernetes.io/docs/tasks/run-application/run-stateless-application-deployment/#creating-and-exploring-an-nginx-deployment

Consider also mentioning code samples in a localization context. Typically, code samples copy over unchanged but natural-language comments might want translating. For example: https://github.com/kubernetes/website/blob/master/content/ko/examples/application/deployment.yaml

/help
@k8s-ci-robot
Copy link
Contributor

@sftim:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

This is a Feature Request

What would you like to be added
In the style guide, explain when to make code samples (eg manifests) downloadable, and how to do that.

Why is this needed
https://kubernetes.io/docs/contribute/style/style-guide/ does not mention how to style downloadable code blocks.
If you know what to search for I think it's easy to work out the convention. Essentially, pages that provide ready-to-run sample manifests should put them in content/en/examples/debug/counter-pod.yaml (for English localization) and reference the downloadable code sample directly.

Comments

For example: https://kubernetes.io/docs/tasks/run-application/run-stateless-application-deployment/#creating-and-exploring-an-nginx-deployment

Consider also mentioning code samples in a localization context. Typically, code samples copy over unchanged but natural-language comments might want translating. For example: https://github.com/kubernetes/website/blob/master/content/ko/examples/application/deployment.yaml

/help

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Dec 22, 2019
@sftim
Copy link
Contributor Author

sftim commented Dec 22, 2019

If the existing mechanism isn't clear, and you'd like to help, I'll be happy to explain my understanding of it.

@sftim sftim closed this as completed Dec 22, 2019
@sftim sftim reopened this Dec 22, 2019
@sftim
Copy link
Contributor Author

sftim commented Dec 22, 2019

Oops, wrong click.

@anshprat
Copy link
Contributor

/assign anshprat

anshprat pushed a commit to anshprat/website that referenced this issue Dec 23, 2019
@anshuprateek-grabtaxi
Add {{< codenew >}} shortcode to style guide
0c9d46b 
This fixes kubernetes#18231
@anshprat anshprat mentioned this issue Dec 23, 2019
Closed
anshprat pushed a commit to anshprat/website that referenced this issue Dec 23, 2019
@anshuprateek-grabtaxi
Add codenew shortcode to style guide
1842018 
This is for kubernetes#18231
anshprat pushed a commit to anshprat/website that referenced this issue Dec 23, 2019
@anshuprateek-grabtaxi
Add codenew shortcode to style guid
6bc5b71 
This is for kubernetes#18231
@anshprat anshprat mentioned this issue Dec 23, 2019
Closed
anshprat pushed a commit to anshprat/website that referenced this issue Dec 23, 2019
@anshuprateek-grabtaxi
Add codenew shortcode to style guide
4e01e79 
added review changes for kubernetes#18231
anshprat pushed a commit to anshprat/website that referenced this issue Dec 24, 2019
@anshuprateek-grabtaxi
Add newecode shortcode
726de9c 
This is for downloadable code snippet.
Also add link to code-snippet-formatting pointing to above
This is for kubernetes#18231
@sftim
Copy link
Contributor Author

sftim commented Jan 18, 2020

I just noticed that https://kubernetes.io/docs/contribute/style/write-new-topic/#including-code-from-another-file does mention this shortcode.

anshprat pushed a commit to anshprat/website that referenced this issue Jan 25, 2020
@anshuprateek-grabtaxi
Add newcode shortcode
0b0244b 
    
This is for downloadable code snippet.
Also add link to code-snippet-formatting pointing to above
This is for kubernetes#18231
anshprat pushed a commit to anshprat/website that referenced this issue Jan 25, 2020
@anshuprateek-grabtaxi
Add newcode shortcode
9f30fbb 
This is for downloadable code snippet.
Also add link to code-snippet-formatting pointing to above
This is for kubernetes#18231
anshprat pushed a commit to anshprat/website that referenced this issue Jan 25, 2020
@anshuprateek-grabtaxi
Add newcode shortcode
9bb77ef 
This is for downloadable code snippet.
Also add link to code-snippet-formatting pointing to above
This is for kubernetes#18231
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 17, 2020
@sftim
Copy link
Contributor Author

sftim commented Apr 18, 2020

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 18, 2020
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 17, 2020
@sftim
Copy link
Contributor Author

sftim commented Jul 19, 2020

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 19, 2020
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 17, 2020
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 14, 2021
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 17, 2021
@sftim
Copy link
Contributor Author

sftim commented Mar 17, 2021

/remove-lifecycle rotten

@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Mar 17, 2021
@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 15, 2021
@shannonxtreme shannonxtreme mentioned this issue Jun 30, 2021
Closed
7 tasks
@fejta-bot
Copy link

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-contributor-experience at kubernetes/community.
/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jul 16, 2021
@sftim
Copy link
Contributor Author

sftim commented Aug 3, 2021

/triage accepted
/lifecycle frozen

@k8s-ci-robot k8s-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Aug 3, 2021
@sftim
Copy link
Contributor Author

sftim commented Oct 8, 2022

/sig docs
/language en

@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. language/en Issues or PRs related to English language labels Oct 8, 2022
@sftim sftim changed the title Describe {{< codenew >}} shortcode in style guide Describe {{< codenew >}} shortcode in style guide Nov 7, 2022
@mehabhalodiya
Copy link
Contributor

@anshprat I don't see any updates; so unassigning you. Please feel free to assign, if you come back here again and are willing to work on 🙂
/unassign @anshprat

@dipesh-rawat
Copy link
Member

I'm happy to make the required changes and get this issue moving forward.

/assign

@dipesh-rawat dipesh-rawat mentioned this issue Mar 2, 2023
Merged
@dipesh-rawat
Copy link
Member

Changes to addressed this issue have been merged as part of PR #39764

@dipesh-rawat
Copy link
Member

Completed via #39764

/close

@k8s-ci-robot
Copy link
Contributor

@dipesh-rawat: Closing this issue.

In response to this:

Completed via #39764

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dipesh-rawat dipesh-rawat

Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. language/en Issues or PRs related to English language lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. sig/docs Categorizes an issue or PR as relevant to SIG Docs. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@anshprat @dipesh-rawat @k8s-ci-robot @sftim @fejta-bot @mehabhalodiya