Docs unify format #578

Merged
merged 15 commits into from May 25, 2015

Projects

None yet

3 participants

@Metallion
Member

Many pages on the documentation were using different header sizes etc. I gave them all a more unified look. I also removed the table of contents on the security groups page. A table of contents feature is already implemented in the mkdocs theme we are using.

@triggers triggers commented on an outdated diff May 19, 2015
docs/content/community.md
@@ -6,7 +6,7 @@ If you wish to contribute to this website, you will need to have a [Github](http
This will not be a one-way conversation. We welcome (well argumented and respectful) discussions about what the documentation should be like. Once we're satisfied with your contribution, we will merge it and publish it to the main website.
-This site's development repository is located here: [https://github.com/axsh/wakame-vdc](https://github.com/axsh/wakame-vdc)
+This site's development repository is located here: [https://github.com/axsh/wakame-vdc/docs](https://github.com/axsh/wakame-vdc/docs)
@triggers
triggers May 19, 2015 Contributor

"development repository" -> "documentation repository" ??

@triggers triggers commented on the diff May 19, 2015
docs/content/development.md
@@ -14,7 +14,7 @@ The main backend source code is in the [dcmgr](https://github.com/axsh/wakame-vd
The file [dcmgr/lib/dcmgr.rb](https://github.com/axsh/wakame-vdc/blob/master/dcmgr/lib/dcmgr.rb) provides a nice overview of the code. It shows the module and class structure.
-#### WebAPI
+### WebAPI
The WebAPI code uses [Sinatra](http://www.sinatrarb.com) and is in the [dcmgr/lib/dcmgr/endpoints/12.03](https://github.com/axsh/wakame-vdc/tree/master/dcmgr/lib/dcmgr/endpoints/12.03) directory.
@triggers
triggers May 19, 2015 Contributor

Probably you meant to change "#### Hypervisor drivers" too. BTW, in the browsers I'm using these changes are very very subtle...not sure if that could be a design issue or not.

@Metallion
Metallion May 20, 2015 Member

A change from h4 to h3 is indeed very subtle in this theme but we should enforce a standard anyway. It's cleaner and will make our lifes easier if we eventually switch to another theme where the difference might not to be so subtle.

@triggers triggers commented on the diff May 19, 2015
docs/content/installation.md
These Wakame-vdc packages have installed OpenVZ as a dependency. OpenVZ runs on a custom kernel. Reboot your machine so that kernel gets loaded.
-#### Set up bridged networking
+### Set up bridged networking
@triggers
triggers May 19, 2015 Contributor

This does not seem right:

   83:### Set up bridged networking
  126:#### Configuration

The configuration section is not about bridged networking.

@triggers triggers commented on the diff May 19, 2015
docs/content/instance-backup/index.md
On an environment installed according to the installation guide, it will have this output
- UUID Storage Type Base URI
- bkst-local local file:///var/lib/wakame-vdc/images/
+```bash
+UUID Storage Type Base URI
+bkst-local local file:///var/lib/wakame-vdc/images/
+```
@triggers
triggers May 19, 2015 Contributor

This is interesting. I was wondering what difference the bash would make. Here it makes the word "local" blue(maybe) because local is a bash keyword. What should be put here not to color any text?

@Metallion
Metallion May 20, 2015 Member

I researched it and it looks like there's currently no way to turn off syntax highlighting. It looks like bash is our best bet at the moment.

https://groups.google.com/forum/#!msg/mkdocs/_aYYBMj7SMc/pqLZ2azWRcwJ

http://highlightjs.readthedocs.org/en/latest/css-classes-reference.html

@Mopster
Mopster May 25, 2015 Contributor

maybe you can used a normal <pre>...</pre> ?

@Mopster
Contributor
Mopster commented May 25, 2015

👍

@Metallion Metallion merged commit bfb5438 into master May 25, 2015
@Metallion Metallion deleted the docs-unify-format branch May 25, 2015
@Metallion Metallion added a commit that referenced this pull request May 25, 2015
@Metallion Metallion Rebuilt after merging #578 036a3cc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment