md-check's Introduction

Kubernetes Markdown Formatter and Linter

Warning: This project is still in Development (not yet Alpha).

md-check is a tool for formatting and linting Kubernetes Docs in Kubernetes repositories, and is originally based on mungedocs.

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

Slack: #kubernetes-wg-contribex
Mailing List: https://groups.google.com/forum/#!forum/kubernetes-wg-contribex

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct

Development

As with all Kubernetes repos, md-check should live under a k8s.io directory.

md-check's People

Contributors

Stargazers

Watchers

md-check's Issues

Complete project info

Start from:
https://github.com/kubernetes/kubernetes-template-project

I'd like to rename this repo to something other than md-format to avoid confusing with other markdown formatters. It may eventually do formatting, but let's not start there. I plan on renaming the repo to something like md-examiner.

Can't build it

E:\go\src\github.com\kubernetes\md-check>go build
main.go:24:2: cannot find package "k8s.io/md-check/checks" in any of:
        E:\go\src\github.com\kubernetes\md-check\vendor\k8s.io\md-check\checks (vendor tree)
        C:\Program Files\Dev\Go\src\k8s.io\md-check\checks (from $GOROOT)
        E:\go\src\k8s.io\md-check\checks (from $GOPATH)
main.go:25:2: cannot find package "k8s.io/md-check/checks/md" in any of:
        E:\go\src\github.com\kubernetes\md-check\vendor\k8s.io\md-check\checks\md (vendor tree)
        C:\Program Files\Dev\Go\src\k8s.io\md-check\checks\md (from $GOROOT)
        E:\go\src\k8s.io\md-check\checks\md (from $GOPATH)

Create a SECURITY_CONTACTS file.

As per the email sent to kubernetes-dev[1], please create a SECURITY_CONTACTS
file.

The template for the file can be found in the kubernetes-template repository[2].
A description for the file is in the steering-committee docs[3], you might need
to search that page for "Security Contacts".

Please feel free to ping me on the PR when you make it, otherwise I will see when
you close this issue. :)

Thanks so much, let me know if you have any questions.

(This issue was generated from a tool, apologies for any weirdness.)

[1] https://groups.google.com/forum/#!topic/kubernetes-dev/codeiIoQ6QE
[2] https://github.com/kubernetes/kubernetes-template-project/blob/master/SECURITY_CONTACTS
[3] https://github.com/kubernetes/community/blob/master/committee-steering/governance/sig-governance-template-short.md

Recommend Projects