Traceview's open source documentation repo
Ruby Perl CSS JavaScript HTML Java Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
config
drupal_imports
gulp
master
plugins
source
staging
.bowerrc
.gitignore
.travis.yml
Capfile
Gemfile
Gemfile.lock
README.markdown
Rakefile
Vagrantfile
_config.yml
bower.json
gulpfile.js
license
linklint-2.3.5
linklint_command
package.json

README.markdown

Traceview Documentation

Build Status

Welcome to the documentation repo for Traceview! If you have any questions about submitting Pull Requests please reach out to traceviewsupport@solarwinds.com

This site is based on sendgrid docs which in turn is based on Octopress, which is in turn based on Jekyll, with a dash of Twitter Bootstrap added.

Local Setup

  • Clone the repo.
  • The following steps assumes you have npm, bower and bundler already installed on your dev environment. If they are not, please install them first
  • npm install to install build tools.
  • bower install to install client-side dependencies (jQuery, bootstrap)
  • bundle install to install required rubygems.
  • Set your root (if you're running locally it'll just be /) in _config.yml
  • bundle exec rake preview
  • Browse to localhost:4000

Config your local

The config is defined in _config.yml.

The only config variables you should need to know about are root, which is the root from which all links are calculated, and the folder_weights hash, which specifies the order that the folders should be displayed in the nav tree. Higher weights mean higher display priority (higher in the tree). You can also specify icons for folders with the folder_icons hash.

There's also a version number in the config.

Important Things to Know

  • The source files are in /source, and the generated files will be created in /public. They get overwritten or wiped out when the site is rebuilt.

  • To rebuild the site: rake generate

Config

The config is defined in _config.yml.

The only config variables you should need to know about are root, which is the root from which all links are calculated, and the folder_weights hash, which specifies the order that the folders should be displayed in the nav tree. Higher weights mean higher display priority (higher in the tree). You can also specify icons for folders with the folder_icons hash.

There's also a version number in the config.

The Nav Tree

The nav tree is generated by the plugin site_navigation.rb. It is essentially a recursive traversal of all the folders and pages in the Source folder that generates a hierarchical tree, sorted by folder weight and page weight.

Breadcrumbs are generated by the breadcrumbs.rb plugin.

Pages

You can write pages in markdown, HTML, or HAML. They all get converted to HTML when the site is generated.

Pages have a block of YAML at the top that sets a few options. They are pretty self explanatory; here's an example

---
layout: page
weight: 0
title: Docs Home
icon: icon-home
showTitle: false
navigation:
  show: true
---

Weights are same as the folder weights - the higher numbers move higher up the tree. Icons are based on the CSS icon class names from Twitter Bootstrap. showTitle and navigation["show"] both default to true if not specified.

By default <title> tags follow the template {Page Title} {Site Title}. However the page title can be changed for the purpose of the tag by using seo["title"]. seo["override"] will override the entire template, instead making the title tage {seo["title"]}. description and canonical change their respective tags.