Skip to content

Latest commit

 

History

History
118 lines (80 loc) · 3.51 KB

README.md

File metadata and controls

118 lines (80 loc) · 3.51 KB
Raw

Blog (grafana.com/blog) and documentation assets

This repo hosts the blog for the grafana.com website. It's a static page generator based on Hugo.

It also hosts all images for the documentation, as well as the Dockerfile for the build image needed to deploy docs (this is not needed for blog publishing).

Small edits

For small edits you don't need to clone and build the repo. Instead, open the file in GitHub, edit it, and open a PR with the change. Once the PR is approved, the change will go live with the next deployment.

Writing blog posts

To write a blog post and preview it locally, you need to install Hugo and some dependencies.

Set up

Install the software needed to run the blog locally. You should have to do this only once.

  • Install Hugo, the static site generator

    (Note: The exact version 0.30.2 is needed only for the person doing the publishing, since recent versions break version switching of the docs site. If you plan to write blog posts only, then a recent version of hugo is fine, and may be installed via brew install hugo, allowing you to skip the manual install below.)

    Linux:

    curl -sSL https://github.com/gohugoio/hugo/releases/download/v0.30.2/hugo_0.30.2_Linux-64bit.tar.gz \
\
  && sudo chmod 755 /usr/local/bin/hugo \
  && /usr/local/bin/hugo version

    Mac:

    curl -sSL https://github.com/gohugoio/hugo/releases/download/v0.30.2/hugo_0.30.2_macOS-64bit.tar.gz \
\
  && sudo chmod 755 /usr/local/bin/hugo \
  && /usr/local/bin/hugo version

  • Install nodejs, version 6 and above is fine, check with node -v

  • Install bower, the dependency manager and grunt, the task runner

npm install -g bower
npm install -g grunt

Build

To build and run the blog locally, do the following steps:

  • Install dependencies if you have not used this repo in a while:
npm install
bower install
  • Build and blog site and start a watcher for changes on modifying sass/html/md files
grunt # build it once
grunt watch
grunt connect

You should be able to see the blog site loading fine in the browser.

Write blog post

First time writers:

Make sure an author file with your name exists under data/authors/ If not, create a file under your name. See david.yaml for an example:

name: David Kaltschmidt
imgUrl: /img/about/david_kaltschmidt.jpg

Then add a square-shaped headshot under static/img/about/. Check out some existing ones to see what is required.

  1. Blog posts are added under content/blog/. Look for recent blog post that fits your style and duplicate it.
  2. Adjust the date in the filename and the header to a possible publishing date. Add a proper title.
  3. Write the blog post.
  4. Commit the post (and your author files if needed) to branch and open a PR.

Publishing

Merges into the master branch are automaitcally deployed to https://staging.grafana.com/blog/.

To deploy master to https://grafana.com/blog/, find the latest master workflow on https://circleci.com/gh/grafana/workflows/grafana.org/tree/master and click "approve-production".

Admin

To build the Docker image for docs:

This repo includes the Dockerfile and assets to build the grafana docs. It will include the assets from this repo and then combine them with the docs from the grafana repo.

Build the Docker image used to deploy docs:

make docs-build

Then continue in the grafana repo.