Commit Graph

7 Commits (7494d882cafaea84cfc0049d2ecb56475ce3d369)

Author SHA1 Message Date
Tim Bannister ca9e44ff9c Tidy reference doc generation guide (#14825)
- fix YAML marked as shell
- trim trailing whitespace
2019-06-16 18:04:07 -07:00
Qiming ad80069302 Revise guide for generating reference docs (#13375)
* Revise guide for generating reference docs

This PR changes the guidance for generating reference documentation for
Kubernetes API and kubernetes components. The topic of making changes to
the upstream repo is separated out because 1) it is not a mandatory step
for generating the reference docs; 2) it is about a more advanced level
of documentation fix.

* light copyedit

* more light copyedits
2019-04-19 12:45:54 -07:00
chenrui 5a5f77db64 Fix relative links issue in English content (#13307)
* `http://kubernetes.io/docs/` -> `/docs/` in content/en folder

* `https://kubernetes.io/docs/` -> `/docs/` in content/en folder
2019-03-20 16:05:05 -07:00
Karen Bradshaw 9a34fa470d fix typo ref contrib (#11096) 2018-11-19 17:54:07 -08:00
Luc Perkins d65e1790ff Add admonition type to shortcode (#9482)
* Change existing admon blocks

* Fix includes issue
2018-11-06 11:33:04 -08:00
Qiming 26f0a81b65 Rework tool/doc for updating reference docs (#10123)
* WIP - rework update imported docs

* Rework tool/doc for updating reference docs

This PR reimplement the reference docs generator in Python and fixes
some outdated docs and data:

- Do docs import using Python because the GoLang version of tool has
  some following drawbacks:
  * its not convenient for handling YAML config files
  * it has to be compiled to binaries to run on different platforms
  * for every tiny changes you need to compile a new version and check in
- The reference docs we use in website are actually not coming directly
  from `kubernetes/kubernetes`. Most of them come from the `reference-docs`
  project. The configuration files are thus changed to avoid confusion.
- We have changed the location of generated docs so the default configuration
  files and the docs are updated.
2018-09-21 14:08:50 -07:00
Misty Linville 5ae0d0dd8d Reorganize docs contrib guide (#9510)
* Reorganize docs contrib guide

* Address first round of feedback from Brad, Jared

* Standardize on 'SIG Docs'

* Address more feedback

* Rewrites to participating.md

* Tweak navigation titles

* Document PR Wrangler

* Document SIG Docs chairperson

* Fix codeblock that shows how to use <codenew>

It was being interpreted as a Hugo shortcode.
2018-08-06 16:15:57 -07:00