k8s-doc
所属分类:微服务
开发工具:HTML
文件大小:79797KB
下载次数:0
上传日期:2018-03-24 07:49:05
上 传 者:
sh-1993
说明: k8s文档.cn,,
(k8s-doc.cn,,)
文件列表:
404.md (178, 2018-03-22)
CONTRIBUTING.md (2516, 2018-03-22)
DocUpdate.md (286, 2018-03-22)
Gemfile (1583, 2018-03-22)
Gemfile.lock (4565, 2018-03-22)
LICENSE (18647, 2018-03-22)
Makefile (724, 2018-03-22)
OWNERS (173, 2018-03-22)
OWNERS_ALIASES (4666, 2018-03-22)
_config.yml (2035, 2018-03-22)
_data (0, 2018-03-22)
_data\canonical-tags (0, 2018-03-22)
_data\canonical-tags\architecture.yaml (85, 2018-03-22)
_data\canonical-tags\community.yaml (90, 2018-03-22)
_data\canonical-tags\core-object.yaml (100, 2018-03-22)
_data\canonical-tags\extension.yaml (83, 2018-03-22)
_data\canonical-tags\fundamental.yaml (93, 2018-03-22)
_data\canonical-tags\networking.yaml (129, 2018-03-22)
_data\canonical-tags\operation.yaml (80, 2018-03-22)
_data\canonical-tags\security.yaml (90, 2018-03-22)
_data\canonical-tags\storage.yaml (91, 2018-03-22)
_data\canonical-tags\tool.yaml (89, 2018-03-22)
_data\canonical-tags\user-type.yaml (88, 2018-03-22)
_data\canonical-tags\workload.yaml (77, 2018-03-22)
_data\concepts.yml (5578, 2018-03-22)
_data\docs-home.yml (1015, 2018-03-22)
_data\globals.yml (109, 2018-03-22)
_data\glossary (0, 2018-03-22)
_data\glossary\_example.yml (800, 2018-03-22)
_data\glossary\annotation.yaml (449, 2018-03-22)
_data\glossary\application-architect.yaml (450, 2018-03-22)
_data\glossary\application-developer.yaml (347, 2018-03-22)
_data\glossary\approver.yaml (544, 2018-03-22)
_data\glossary\certificate.yaml (403, 2018-03-22)
_data\glossary\cla.yaml (431, 2018-03-22)
... ...
# Update imported docs
This script updates the target files generated from other repos listed in the file, which is specified as the command line argument.
## Requirements
Imported docs must follow these guidelines:
1. Be listed somewhere in the `/_data/imported.yml` table of contents file.
1. Have `title` defined in the front matter. For example:
```
---
title: Title Displayed in Table of Contents
---
Rest of the .md file...
```
1. Adhere to the [Documentation Style Guide](https://github.com/docs/home/contribute/style-guide/).
## Usage
From within this directory, run the following command:
```
./update-imported-docs
```
The output should look similar to the following:
```
Website root directory: /Users/someuser/git/kubernetes-website
* * *
Cloning repo "community"...
* * *
Docs imported! Run 'git add .' 'git commit -m ' and 'git push' to upload them.
```
## Config file format
Each config file may contain multiple repos, which will be imported together. You should modify the corresponding `update-imported-docs/` file to reflect the desired `src` and `dst` paths.
You may also create new config files for different groups of documents to import. The following is an example of the YAML file format:
```
repos:
- name: kubernetes #tmp directory name
remote: https://github.com/kubernetes/kubernetes.git
branch: release-1.9
generate-command: hack/generate-docs.sh #optional command to run
files:
- src: docs/admin/cloud-controller-manager.md
dst: docs/reference/generated/cloud-controller-manager.md
- src: docs/admin/kube-apiserver.md
dst: docs/reference/generated/kube-apiserver.md
- name: community #tmp directory name
remote: https://github.com/kubernetes/community.git
branch: master
files:
- src: contributors/devel/README.md
dst: docs/imported/community/devel.md
- src: contributors/guide/README.md
dst: docs/imported/community/guide.md
```
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.
## Fixing Links
To fix relative links within your imported files, set the repo config's `gen-absolute-links` value to `true`. You can see an example of this in [`community.yml`](https://github.comcommunity.yml).
近期下载者:
相关文件:
收藏者: