https://github.com/concourse/docs
concourse documentation and website
https://github.com/concourse/docs
Last synced: about 1 year ago
JSON representation
concourse documentation and website
- Host: GitHub
- URL: https://github.com/concourse/docs
- Owner: concourse
- Created: 2017-09-25T23:06:55.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T00:02:41.000Z (about 2 years ago)
- Last Synced: 2024-04-14T00:34:03.272Z (about 2 years ago)
- Language: JavaScript
- Homepage: https://concourse-ci.org
- Size: 35.3 MB
- Stars: 56
- Watchers: 17
- Forks: 154
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Concourse Docs
This is where you will find the source for the Concourse website and overall
documentation. All of our docs are written using the [Booklit documentation
engine](https://vito.github.io/booklit/).
**Table of Contents**
* [Building the Docs Locally](#building-the-docs-locally)
* [Docs Styling](#docs-styling)
* [Content Layout](#content-layout)
# Examples Status
- git-triggered [](https://ci.concourse-ci.org/teams/examples/pipelines/git-triggered)
- golang-lib [](https://ci.concourse-ci.org/teams/examples/pipelines/golang-lib)
- hooks [](https://ci.concourse-ci.org/teams/examples/pipelines/hooks)
- java [](https://ci.concourse-ci.org/teams/examples/pipelines/java)
- job [](https://ci.concourse-ci.org/teams/examples/pipelines/job)
- manual-trigger [](https://ci.concourse-ci.org/teams/examples/pipelines/manual-trigger)
- nodejs [](https://ci.concourse-ci.org/teams/examples/pipelines/nodejs)
- php [](https://ci.concourse-ci.org/teams/examples/pipelines/php)
- pipeline-vars [](https://ci.concourse-ci.org/teams/examples/pipelines/pipeline-vars)
- rails [](https://ci.concourse-ci.org/teams/examples/pipelines/rails)
- serial-job [](https://ci.concourse-ci.org/teams/examples/pipelines/serial-job)
- task-passing-artifact [](https://ci.concourse-ci.org/teams/examples/pipelines/task-passing-artifact)
- time-triggered [](https://ci.concourse-ci.org/teams/examples/pipelines/time-triggered)
# Building the Docs Locally
## Prerequisites
* Have Go v1.11.2+ installed and configured. You can find the relevant
instructions for your platform of choice here: [Go Getting
Started](https://golang.org/doc/install)
* Clone this repository:
[https://github.com/concourse/docs](https://github.com/concourse/docs)
## Compiling the Docs
You can compile the Concourse docs by running:
```bash
./scripts/build
```
The `build` script will instruct Booklit to compile all the files under `lit/`
as `html` files. The files will then be dumped into your current working
directory, i.e. the root of this repo.
## Viewing the docs in your browser
To run a server that will rebuild the docs as needed, pass `-s (port)` like so:
```bash
./scripts/build -s 8000
```
You will be now be able to see the rendered site if you navigate to
[http://localhost:8000](http://localhost:8000).
# Docs Styling
You can find all of the styling assets for the Concourse website and documentation under the [`css/`](./css) folder.
If you are planning to make changes to the site, [`css/booklit.css`](./css/booklit.css) is usually a good place to start.
# Content Layout
All of the website content can be found under the [`lit/`](./lit) folder of this repository.
The content layout for the site is qute simple, and for the most part self-explanatory. If you want to change a specific page on the website you can usually jump straight to it by looking for the `.lit` version of the page. For example you can make changes to https://concourse-ci.org/fly.html by editing `lit/fly.lit`.
* [`html/docs-header.tmpl`](./html/docs-header.tmpl) L1 navigation header for the Concourse website and docs.
* [`lit/index.lit`](./lit/index.lit) The Concourse Homepage
* [`lit/docs/`](./lit/docs/) This is where you'll find most of the documentation listed under https://concourse-ci.org/docs.html
The Resource Types live in a separate repository: [concourse/resource-types](https://github.com/concourse/resource-types).
# Updating the Blog Theme
```sh
$ make blog/concourse.zip
# and then upload it in the Ghost admin UI
```