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

Fix minor markdown issue in ServiceAccount docs #27509

Closed
wants to merge 1 commit into from

Conversation

codedevote
Copy link

Fix minor issue in ServiceAccount docs.

Fix minor issue in ServiceAccount docs.
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
  • Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Apr 11, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @codedevote!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@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 zparnold after the PR has been reviewed.
You can assign the PR to them by writing /assign @zparnold 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

@k8s-ci-robot k8s-ci-robot added 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 Apr 11, 2021
@codedevote
Copy link
Author

/signed

@netlify
Copy link

netlify bot commented Apr 11, 2021

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

Built with commit 57d593e

https://deploy-preview-27509--kubernetes-io-master-staging.netlify.app

@@ -16,7 +16,10 @@ weight: 1

## ServiceAccount {#ServiceAccount}

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets
ServiceAccount binds together:
Copy link
Contributor

Choose a reason for hiding this comment

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

Hello @codedevote .
This content is auto-generated by the API reference generator.
/cc @feloy .

Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

@codedevote
Copy link
Author

more info about CLA, check please
https://github.com/kubernetes/community/blob/master/CLA.md

I acutally signed the CLA 6 days ago. Maybe I didn't trigger the bot correctly.

@codedevote
Copy link
Author

As it seems I may have missed a step, which I now finished. Should be fine now (hopefully).

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Apr 17, 2021
@feloy
Copy link
Member

feloy commented Apr 17, 2021

Hi @codedevote , this content is generated from the comments into the Kubernetes sources, changing this file won't have any effect as the changes will be overwritten the next time the files will be generated.

For the moment, there is no way to correct this kind of Markdown issue (as the comments in the sources are not specifically in markdown format).

@codedevote
Copy link
Author

Hi @feloy, ok, didn't know that. So I guess you can close this one. And just for future reference - is there a guide somewhere that would explain how to fix such minor documentation issues. It seems like I fell into the trap to believe that "Edit this page", (see screensot), which is available on every page in the docs, is actually the way to go...
image

@kbhawkey
Copy link
Contributor

Hi @codedevote .
You bring up a good point.
The layout template from the theme, which includes these links, was recently customized for this site.
The API resources generator could add an attribute to the front matter of each generated page.
When the auto_generated attribute is set to true, the "edit this page" links are not displayed.
@feloy, What do you think about adding the auto_generated attribute to the generator?

Here is the front matter of a generated config-api page that includes the attribute:

---
title: WebhookAdmission Configuration (v1)
content_type: tool-reference
package: apiserver.config.k8s.io/v1
auto_generated: true
---

@feloy
Copy link
Member

feloy commented Apr 18, 2021

@kbhawkey Yes, I'll add this attribute to the generated pages

@feloy
Copy link
Member

feloy commented Apr 18, 2021

@kbhawkey I've added the auto_generated metadata, but I cannot see the expected result, that the Edit this page should be removed.

Is this feature implemented or is it a work in progress?

@kbhawkey
Copy link
Contributor

@feloy, I thought the related PR was merged (#27393).
It is now. The generated reference pages that use this attribute should omit the "edit" links.

@kbhawkey
Copy link
Contributor

👋 @codedevote .
I am closing this PR.
Thanks for your suggestions!
/close

@k8s-ci-robot
Copy link
Contributor

@kbhawkey: Closed this PR.

In response to this:

👋 @codedevote .
I am closing this PR.
Thanks for your suggestions!
/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
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.

5 participants