|
1 | | -# kubicorn.io |
2 | | - |
3 | | -Here is the content of the official `kubicorn` website: [kubicorn.io](http://kubicorn.io). |
4 | | - |
5 | | -All documentation for the project is hosted in the [docs section](http://kubicorn.io/documentation/readme.html) of [kubicorn.io](http://kubicorn.io). |
6 | | - |
7 | | -The website runs on Jekyll, straight from GitHub Pages. It consists of templates and markdown files that are automatically built into HTML pages whenever any of the content changes. |
8 | | - |
9 | | -The most common edits are changing the home.html file (our index page), and adding or editing files in the documentation/ folder. |
10 | | - |
11 | | -# Website structure |
12 | | - |
13 | | -``` |
14 | | -kubicorn/docs/ |
15 | | -│ |
16 | | -├── assets/ |
17 | | -│ → This folder basically contains the favicons. We should probably move this |
18 | | -│ to img/ sometime. |
19 | | -│ |
20 | | -├── docs_old/ |
21 | | -│ → These are the old docs from before kubicorn had a website. |
22 | | -│ |
23 | | -├── _documentation/ |
24 | | -│ → All docs to be displayed on in the Documentation section of the website |
25 | | -│ should go here. They should be markdown, and include the YAML header as |
26 | | -│ shown in the *Adding a new page* section below. |
27 | | -│ |
28 | | -├── _friends/ |
29 | | -│ → Files in this folder feed the *Friends of kubicorn* section of the website. |
30 | | -│ You should follow the formatting as per the files already present. |
31 | | -│ |
32 | | -├── _includes/ |
33 | | -│ → This holds the includes for every page of the website: footer, header, and |
34 | | -│ head sections. |
35 | | -│ |
36 | | -├── _layouts/ |
37 | | -│ │ → This holds the different templates that make up the website. In |
38 | | -│ │ practice we're only using two: |
39 | | -│ │ |
40 | | -│ ├── documentation.html |
41 | | -│ │ → This is the template used to generate all files in the documentation |
42 | | -│ │ section. |
43 | | -│ │ |
44 | | -│ └── home.html |
45 | | -│ → This is the website's index page. Most of the text in the index page |
46 | | -│ is hard-coded here. Exceptions are the _friends/ content and the |
47 | | -│ _documentation/ list, which are generated dynamically. |
48 | | -│ |
49 | | -├── img/ |
50 | | -│ → All images go here. |
51 | | -│ |
52 | | -├── _posts/ & _sass/ |
53 | | -│ → These are defaults from the initial Jekyll installation, and should be |
54 | | -│ cleaned up at some point. |
55 | | -│ |
56 | | -└── _site/ |
57 | | - → This folder contains the auto-generated files that the website serves. They |
58 | | - are built automatically whenever anything else on the folders above change, |
59 | | - and should not be edited manually. Any changes to these files will be |
60 | | - discarded. |
61 | | - |
62 | | -``` |
63 | | - |
64 | | -## Adding a new page |
65 | | - |
66 | | -To create a new page on the website, create a new `.md` markdown file in `/docs/_documentation`. |
67 | | - |
68 | | -All new docs must contain the header: |
69 | | - |
70 | | -``` |
71 | | ---- |
72 | | -layout: documentation |
73 | | -title: [The title of your document] |
74 | | -date: YYYY-MM-DD |
75 | | -doctype: [general/aws/azure/do/google/packet] |
76 | | ---- |
77 | | -``` |
78 | | - |
79 | | -Where `doctype` is the larger category for the documentation (valid categories are `general`, `aws`, `azure`, `do`, `google` and `packet`). All docs should be written in valid `.md` markdown. |
80 | | - |
81 | | -Do not include a title top level header on the document, e.g. `# Title`. The title is pulled from `title: value` on the section above. You can start your file with a level two header, e.g. `## Second level header`, or go straight to normal text. |
82 | | - |
83 | | -## Editing existing documentation |
84 | | - |
85 | | -Simply update the associated `.md` markdown file. All documentation should be in complete sentences. |
86 | | - |
87 | | -# Testing changes |
88 | | - |
89 | | -If you have Jekyll stack installed you can run the website locally to test changes. To install Jekyll, follow the [Setting up your GitHub Pages site locally with Jekyll](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/) tutorial. |
90 | | -Start the website by running the following command from the `/docs` directory: |
91 | | -``` |
92 | | -bundle exec jekyll serve |
93 | | -``` |
94 | | -The website will be available at `localhost:4000`. |
| 1 | +# Gopherlabs |
0 commit comments