github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #133 from bgrant0607/master 

Dockerized raml2html and regenerated kubernetes.html.
pull/6/head
brendandburns 2014-06-17 10:28:36 -07:00
parent e7125fb7ea 20cc10b5b0
commit fe0cb7c87b
3 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -177,10 +177,9 @@ git rebase upstream/master
``` ```
### Regenerating the documentation ### Regenerating the documentation
Install [nodejs](http://nodejs.org/download/), [npm](https://www.npmjs.org/), and
[raml2html](https://github.com/kevinrenskers/raml2html), then run:
``` ```
cd kubernetes/api cd kubernetes/api
raml2html kubernetes.raml > kubernetes.html sudo docker build -t kubernetes/raml2html - < raml2html.dockerfile
sudo docker run -v `pwd`:/data kubernetes/raml2html
``` ```

17
api/kubernetes.html
View File

@ -4,6 +4,7 @@
<title>Kubernetes API documentation</title> <title>Kubernetes API documentation</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="generator" content="https://github.com/kevinrenskers/raml2html">
<script type="text/javascript"> <script type="text/javascript">
var protocol = ((document.location.protocol === 'https:') ? 'https:': 'http:'); var protocol = ((document.location.protocol === 'https:') ? 'https:': 'http:');
@ -365,7 +366,7 @@ implemented, either.</p>
<h3>Body</h3> <h3>Body</h3>
<p><strong>Type: json/application</strong></p> <p><strong>Type: application/json</strong></p>
<strong>Schema:</strong> <strong>Schema:</strong>
@ -373,7 +374,7 @@ implemented, either.</p>
"<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>, "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>,
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Pod resource. A pod corresponds to a colocated group of [Docker containers](http://docker.io)."</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Pod resource. A pod corresponds to a co-located group of [Docker containers](http://docker.io)."</span></span>,
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
"<span class="hljs-attribute">kind</span>": <span class="hljs-value">{ "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
@ -661,7 +662,7 @@ implemented, either.</p>
<h3>Body</h3> <h3>Body</h3>
<p><strong>Type: json/application</strong></p> <p><strong>Type: application/json</strong></p>
<strong>Schema:</strong> <strong>Schema:</strong>
@ -669,7 +670,7 @@ implemented, either.</p>
"<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>, "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>,
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Pod resource. A pod corresponds to a colocated group of [Docker containers](http://docker.io)."</span></span>, "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Pod resource. A pod corresponds to a co-located group of [Docker containers](http://docker.io)."</span></span>,
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
"<span class="hljs-attribute">kind</span>": <span class="hljs-value">{ "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
@ -1037,7 +1038,7 @@ implemented, either.</p>
<h3>Body</h3> <h3>Body</h3>
<p><strong>Type: json/application</strong></p> <p><strong>Type: application/json</strong></p>
<strong>Schema:</strong> <strong>Schema:</strong>
@ -1296,7 +1297,7 @@ implemented, either.</p>
<h3>Body</h3> <h3>Body</h3>
<p><strong>Type: json/application</strong></p> <p><strong>Type: application/json</strong></p>
<strong>Schema:</strong> <strong>Schema:</strong>
@ -1625,7 +1626,7 @@ implemented, either.</p>
<h3>Body</h3> <h3>Body</h3>
<p><strong>Type: json/application</strong></p> <p><strong>Type: application/json</strong></p>
<strong>Schema:</strong> <strong>Schema:</strong>
@ -1848,7 +1849,7 @@ implemented, either.</p>
<h3>Body</h3> <h3>Body</h3>
<p><strong>Type: json/application</strong></p> <p><strong>Type: application/json</strong></p>
<strong>Schema:</strong> <strong>Schema:</strong>

5
api/raml2html.dockerfile Normal file
View File

@ -0,0 +1,5 @@
FROM google/nodejs
RUN npm i -g raml2html
VOLUME ["/data"]
CMD ["-i", "/data/kubernetes.raml", "-o", "/data/kubernetes.html"]
ENTRYPOINT ["raml2html"]