goa.design

module
v0.0.0-...-d9508cd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 17, 2016 License: MIT

README

goa.design

This repository contains the source code of http://goa.design. The site is a static website built using hugo and served from Google Cloud Storage.

Contributing

Is that typo bugging you? us too! If you want to do something about it:

  1. Fork and clone the repo
  2. Open a terminal and run make inside the repo.

make starts a server on your box that "liveloads" all changes you make to the content (that is the page should refresh itself each time you save a content page).

  1. Edit the content in the /content directory.
  2. Submit a Pull Request

Deployment

After a commit is pushed to the master branch the TravisCI job does the following:

  1. It clones the goa repository in a temporary directory.
  2. It runs a modified version of godoc2md to produce Markdown files from the sources. The modified version also adds anchors to each title.
  3. It runs hugo which produces the HTML from the markdown files (both the static markdown files and the ones generated by godoc2md).
  4. It pushes the results to GCS.

Directories

Path Synopsis
Package weasel provides a simple frontend (App Engine app) that serves content from a Google Cloud Storage (GCS) bucket.
Package weasel provides a simple frontend (App Engine app) that serves content from a Google Cloud Storage (GCS) bucket.
tools
godoc2md
godoc2md converts godoc formatted package documentation into Markdown format.
godoc2md converts godoc formatted package documentation into Markdown format.
linkcheck
The linkcheck command finds missing links in the godoc website.
The linkcheck command finds missing links in the godoc website.
mdc
mdc is a tool that wraps godoc2md so it can run recursively on all packages given a top level package path.
mdc is a tool that wraps godoc2md so it can run recursively on all packages given a top level package path.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL