18F cloud.gov website
This repository contains the site code for the cloud.gov website.
cloud.gov is a Platform as a Service based on the Cloud Foundry project, which provides its own Cloud Foundry documentation.
Contributing
Hugo uses Markdown to build the pages. Add your page to the section you want inside the content folder.
Basic install
- Install Python 2, if it's not on your system already. (Required for node-sass->node-gyp.)
- Install Hugo.
Running the site locally
- Run
npm install
to download all the dependencies. - Run
npm start
and browse to http://localhost:1313.
Environment-specific information
For a block of content that is specific to AWS East/West, use the following shortcode:
{{% eastwest %}}
East/West-specific Markdown content goes here.
{{% /eastwest %}}
Ditto for govcloud
.
Links
To link to another page within cg-site, use relref
to create relative links. Examples:
[What is cloud.gov?]({{< relref "overview/overview/what-is-cloudgov.md" >}})
[Sharing secret keys]({{< relref "docs/ops/secrets.md#sharing-secret-keys" >}})
Redirects
If you delete or rename a page, make a redirect to avoid breaking links from other sites: make an alias (use the "YAML frontmatter" style).
Search
Our search feature is powered by DigitalGov Search, which has a Help Manual with documentation about configuring it. DigitalGov Search for Power Users is also useful.
We use its default Bing indexing, so our search may show outdated results if Bing hasn't recently reindexed our docs site.
Style development
This site uses a shared cloud.gov style, cg-style. This means any styling code has to be developed in cg-style.
- Download or clone the cg-style repository,
git clone git@github.com:18F/cg-style.git
- Run the watching build task in the cg-style repository:
npm run watch
- Run
npm install
in the cg-site repository. - Run
npm link
in cg-site. - Run the watching build task in cg-site repository:
npm run watch
- Edit code in the cg-style directory and they will propagate down to cg-site
Acknowledgment
The theme for the site has been "forked" from the Hugo documentation.