Skip to content

Add frontmatter descriptions to the contributor guide docs #4870

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

Merged

Conversation

mrbobbytables
Copy link
Member

The descriptions will be used on list pages within the contributor site to give a brief overview of the pages 👍
/hold for review

ref: #4444

@k8s-ci-robot k8s-ci-robot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 19, 2020
@k8s-ci-robot k8s-ci-robot added area/contributor-guide Issues or PRs related to the contributor guide sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jun 19, 2020
Comment on lines -1 to -11
---
title: "Contributors Guide"
weight: 1
slug: "guide"
---

<!--
Contributing to this document?
Please use semantic line feeds for readability: http://rhodesmill.org/brandon/2012/one-sentence-per-line/
-->

Copy link
Member Author

Choose a reason for hiding this comment

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

This page is no longer being included and our current practice is to word wrap at 80 characters following the style guide

@mrbobbytables mrbobbytables added this to the v1.19 milestone Jun 19, 2020
Copy link
Member

@nikhita nikhita left a comment

Choose a reason for hiding this comment

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

Thanks, this looks great! Had a couple of comments as an aside that we should probably address in a different PR.

/lgtm

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mrbobbytables, nikhita

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

The pull request process is described 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

@mrbobbytables mrbobbytables force-pushed the add-guide-descriptions branch from f932da2 to 427ccfb Compare June 19, 2020 11:45
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 19, 2020
@nikhita
Copy link
Member

nikhita commented Jun 19, 2020

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 19, 2020
@mrbobbytables
Copy link
Member Author

/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 19, 2020
@k8s-ci-robot k8s-ci-robot merged commit e3be97e into kubernetes:master Jun 19, 2020
@mrbobbytables mrbobbytables deleted the add-guide-descriptions branch September 3, 2020 15:27
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. area/contributor-guide Issues or PRs related to the contributor guide 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. sig/contributor-experience Categorizes an issue or PR as relevant to SIG Contributor Experience. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants