Follow the steps below to work locally with this project.
bundle exec jekyll serve
Note: Changes to
_config.yml require you to stop the Jekyll server (
^C) and restart it with
bundle exec jekyll serve.
You can add
.html files to this project to be rendered. Most handbook pages are written in Markdown.
_srcfolder and locate your team’s handbook section.
my-page.md. Use dashes as spaces in your file name.
All pages require front matter to render properly. At a minimum you will need to specify:
layout:The template file to use when rendering the content. For handbook pages use
page. Custom templates can be created and placed in
title:The title of the page.
weight:This controls how pages are displayed in menus and lists. The first file in each handbook section should be named
index.mdand have a weight of
1. All other pages within a handbook section should have a weight of
permalink:This allows you to set this page’s URL. You can use this to override Jekyll’s automatically generated URLs. Ex.
toc:Set this to
trueto include a Table of Contents on the page. By default this is disabled and should be added manually to pages that need it.
--- layout: page title: Meltano Brand Kit permalink: /marketing/brand weight: 2 toc: true ---
index.md. Set the
weight:of this page to
1– it’ll be the home page for this handbook section.
engineering: output: true icon: "fa-cogs"
icon: Refers to a Font Awesome icon.
imagesfolder in your handbook section.
images/filename.jpgin your pages.
The TOC is managed through the
jekyll-toc gem. You can read about its configuration here.
This is added to all pages by default. It can be turned off by setting
toc: false in the front matter of the document.
You can edit the announcement and CTA under the
announcement section in
display- Set this to
trueto display an announcement or set it to
falseto hide it.
text- This is the announcement text. Keep it short and sweet (~140 characters or less) so it’s not intrusive on the page.
cta- This prompts readers to do something. Make it engaging!
cta-link- This is the link folks will be directed to. It opens in a new page so readers don’t lose their place in the docs.
announcement: display: true text: Meltano v2.0 is almost here! cta: See what's on the roadmap. cta-link: https://handbook.meltano.com/product/roadmap#2022-q2
If you’re running docs locally, you will need to stop the Jekyll server (
^C) and restart it with
bundle exec jekyll serve in order to see updates to announcements. It’s not ideal but it prevents folks from having to edit raw HTML to make changes to announcements.
Builds will fail to deploy if links are broken. You can check for broken links locally with this command before pushing changes:
bundle exec jekyll build && bundle exec htmlproofer --log-level :debug ./_site --assume_extension --http_status_ignore 503 --url-ignore "/www.linkedin.com/,/www.dell.com/,/www.optionimpact.com/"