{"id":13397817,"url":"https://github.com/concourse/docs","last_synced_at":"2025-04-06T15:13:45.997Z","repository":{"id":25791142,"uuid":"104810872","full_name":"concourse/docs","owner":"concourse","description":"concourse documentation and website","archived":false,"fork":false,"pushed_at":"2024-04-14T00:02:41.000Z","size":37032,"stargazers_count":56,"open_issues_count":35,"forks_count":154,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-04-14T00:34:03.272Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://concourse-ci.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/concourse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2017-09-25T23:06:55.000Z","updated_at":"2024-04-15T01:24:49.243Z","dependencies_parsed_at":"2023-02-19T02:46:02.588Z","dependency_job_id":"5e4e10d6-0fec-4679-88c4-83a0806b1cfa","html_url":"https://github.com/concourse/docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/concourse%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/concourse%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/concourse%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/concourse%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/concourse","download_url":"https://codeload.github.com/concourse/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247500470,"owners_count":20948880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T18:01:46.838Z","updated_at":"2025-04-06T15:13:45.981Z","avatar_url":"https://github.com/concourse.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Concourse Docs\n\nThis is where you will find the source for the Concourse website and overall\ndocumentation. All of our docs are written using the [Booklit documentation\nengine](https://vito.github.io/booklit/).\n\n**Table of Contents**\n* [Building the Docs Locally](#building-the-docs-locally)\n* [Docs Styling](#docs-styling)\n* [Content Layout](#content-layout)\n\n# Examples Status\n\n- git-triggered [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/git-triggered/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/git-triggered)\n- golang-lib [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/golang-lib/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/golang-lib)\n- hooks [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/hooks/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/hooks)\n- java [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/java/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/java)\n- job [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/job/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/job)\n- manual-trigger [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/manual-trigger/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/manual-trigger)\n- nodejs [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/nodejs/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/nodejs)\n- php [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/php/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/php)\n- pipeline-vars [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/pipeline-vars/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/pipeline-vars)\n- rails [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/rails/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/rails)\n- serial-job [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/serial-job/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/serial-job)\n- task-passing-artifact [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/task-passing-artifact/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/task-passing-artifact)\n- time-triggered [![](https://ci.concourse-ci.org/api/v1/teams/examples/pipelines/time-triggered/badge)](https://ci.concourse-ci.org/teams/examples/pipelines/time-triggered)\n\n# Building the Docs Locally\n\n## Prerequisites\n\n* Have Go v1.11.2+ installed and configured. You can find the relevant\n  instructions for your platform of choice here: [Go Getting\n  Started](https://golang.org/doc/install)\n\n* Clone this repository:\n  [https://github.com/concourse/docs](https://github.com/concourse/docs)\n\n## Compiling the Docs\n\nYou can compile the Concourse docs by running:\n\n```bash\n./scripts/build\n```\n\nThe `build` script will instruct Booklit to compile all the files under `lit/`\nas `html` files. The files will then be dumped into your current working\ndirectory, i.e. the root of this repo.\n\n## Viewing the docs in your browser\n\nTo run a server that will rebuild the docs as needed, pass `-s (port)` like so:\n\n```bash\n./scripts/build -s 8000\n```\n\nYou will be now be able to see the rendered site if you navigate to\n[http://localhost:8000](http://localhost:8000).\n\n# Docs Styling\n\nYou can find all of the styling assets for the Concourse website and documentation under the [`css/`](./css) folder. \n\nIf you are planning to make changes to the site, [`css/booklit.css`](./css/booklit.css) is usually a good place to start. \n\n# Content Layout\n\nAll of the website content can be found under the [`lit/`](./lit) folder of this repository. \n\nThe 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`. \n\n* [`html/docs-header.tmpl`](./html/docs-header.tmpl) L1 navigation header for the Concourse website and docs.\n* [`lit/index.lit`](./lit/index.lit) The Concourse Homepage\n* [`lit/docs/`](./lit/docs/) This is where you'll find most of the documentation listed under https://concourse-ci.org/docs.html\n\nThe Resource Types live in a separate repository: [concourse/resource-types](https://github.com/concourse/resource-types).\n\n# Updating the Blog Theme\n\n```sh\n$ make blog/concourse.zip\n# and then upload it in the Ghost admin UI\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconcourse%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconcourse%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconcourse%2Fdocs/lists"}