Skip to content

Commit 8f2bfd9

Browse files
committed
update README.md and fix community docs issues
1 parent 4122420 commit 8f2bfd9

File tree

7 files changed

+74
-12
lines changed

7 files changed

+74
-12
lines changed

docs/imported/community/guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Kubernetes Developer Guide
2+
title: Kubernetes Contributor Guide
33
owner: sig-contributor-experience
44
---
55

docs/imported/community/keps.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Kubernetes Enhancement Proposal Process
33
---
44

55
## Metadata
6+
67
```
78
---
89
kep-number: 1
@@ -26,6 +27,7 @@ editor:
2627
name: TBD
2728
creation-date: 2017-08-22
2829
status: draft
30+
---
2931
```
3032

3133
## Table of Contents

docs/imported/community/mentoring.md

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ title: Kubernetes Mentoring Initiatives
44

55
This folder will be used for all mentoring initiatives for Kubernetes.
66

7-
---
87
## Kubernetes Pilots
98

109
We understand that everyone has different learning styles and we want to support as many of those as possible. Mentoring is vital to the growth of an individual and organization of every kind. For Kubernetes, the larger the project becomes, it's necessary to keep a continuous pipeline of quality contributors.

update-imported-docs/README

-10
This file was deleted.

update-imported-docs/README.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Update imported docs
2+
3+
This script updates the target files generated from other repos listed in the <config.yml> file, which is specified as the command line argument.
4+
5+
## Requirements
6+
7+
Imported docs must follow these guidelines:
8+
9+
1. Be listed somewhere in the `/_data/imported.yml` table of contents file.
10+
1. Have `title` defined in the front matter. For example:
11+
12+
```
13+
---
14+
title: Title Displayed in Table of Contents
15+
---
16+
17+
Rest of the .md file...
18+
```
19+
20+
1. Adhere to the [Documentation Style Guide](/docs/home/contribute/style-guide/).
21+
22+
## Usage
23+
24+
From within this directory, run the following command:
25+
26+
```
27+
./update-imported-docs <config.yaml>
28+
```
29+
30+
The output should look similar to the following:
31+
32+
```
33+
Website root directory: /Users/someuser/git/kubernetes-website
34+
35+
* * *
36+
37+
Cloning repo "community"...
38+
39+
* * *
40+
41+
Docs imported! Run 'git add .' 'git commit -m <comment>' and 'git push' to upload them.
42+
```
43+
44+
## Config file format
45+
46+
Each config file may contain multiple repos, which will be imported together. You should modify the corresponding `update-imported-docs/<config.yml>` file to reflect the desired `src` and `dst` paths.
47+
48+
You may also create new config files for different groups of documents to import. The following is an example of the YAML file format:
49+
50+
```
51+
repos:
52+
- name: kubernetes #tmp directory name
53+
remote: https://github.com/kubernetes/kubernetes.git
54+
branch: release-1.9
55+
generate-command: hack/generate-docs.sh #optional command to run
56+
files:
57+
- src: docs/admin/cloud-controller-manager.md
58+
dst: docs/reference/generated/cloud-controller-manager.md
59+
- src: docs/admin/kube-apiserver.md
60+
dst: docs/reference/generated/kube-apiserver.md
61+
- name: community #tmp directory name
62+
remote: https://github.com/kubernetes/community.git
63+
branch: master
64+
files:
65+
- src: contributors/devel/README.md
66+
dst: docs/imported/community/devel.md
67+
- src: contributors/guide/README.md
68+
dst: docs/imported/community/guide.md
69+
```
70+
71+
Note: `generate-command` is an optional entry, which can be used to run a given command to auto-generate the docs from within that repo.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)