{"id":27998075,"url":"https://github.com/alphagov/data-community-tech-docs","last_synced_at":"2025-10-10T07:20:04.011Z","repository":{"id":38366335,"uuid":"400524277","full_name":"alphagov/data-community-tech-docs","owner":"alphagov","description":"Data Community Technical Documentation","archived":false,"fork":false,"pushed_at":"2025-09-19T13:42:41.000Z","size":1545,"stargazers_count":5,"open_issues_count":7,"forks_count":2,"subscribers_count":33,"default_branch":"main","last_synced_at":"2025-09-19T15:44:05.719Z","etag":null,"topics":["data-services","govuk"],"latest_commit_sha":null,"homepage":"https://docs.data-community.publishing.service.gov.uk/","language":"HTML","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/alphagov.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,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-08-27T13:50:11.000Z","updated_at":"2025-09-18T15:39:49.000Z","dependencies_parsed_at":"2023-10-16T19:42:44.123Z","dependency_job_id":"0f922b25-4d76-4959-bf52-828c48cb789d","html_url":"https://github.com/alphagov/data-community-tech-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/alphagov/data-community-tech-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fdata-community-tech-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fdata-community-tech-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fdata-community-tech-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fdata-community-tech-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alphagov","download_url":"https://codeload.github.com/alphagov/data-community-tech-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphagov%2Fdata-community-tech-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279003172,"owners_count":26083533,"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","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["data-services","govuk"],"created_at":"2025-05-08T22:47:21.783Z","updated_at":"2025-10-10T07:20:04.004Z","avatar_url":"https://github.com/alphagov.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Technical Documentation\n\nThis project uses the [Tech Docs Template][template], which is a [Middleman template][mmt] that you can use to build technical documentation using a GOV.UK style.\n\n👉 To find out more about setting up and managing content for a website using this template, see the [Tech Docs Template documentation][tdt-docs].\n\n## Before you start\n\nTo use the Tech Docs Template you need:\n\n- [Ruby][install-ruby]\n- [Middleman][install-middleman]\n\nThe [tech docs template\ndocumentation](https://tdt-documentation.london.cloudapps.digital/create_project/get_started/#install-ruby)\nsays to install the latest 2.7.x version listed at\nhttps://www.ruby-lang.org/en/downloads/ which is 2.7.8, but that page says that\n2.7.8 is no longer maintained, and rbenv will only install 2.7.6.  The\ndocumentation also says to use RVM to install Ruby, but the [GDS\nWay](https://gds-way.cloudapps.digital/manuals/programming-languages/ruby.html#conventional-tooling)\nrecommends rbenv.\n\n## Create a new website\n\n- Install rbenv\n- Install Ruby version 2.7.6 `rbenv install 2.7.6`\n- Activate Ruby version 2.7.6 in your current terminal `rbenv shell 2.7.6`\n- Install an old version of a dependency `rbenv exec gem install contracts -v 0.16.1`\n- Install middleman `rbenv exec gem install middleman`\n- Use middleman to create a new website `rbenv exec middleman init \u003cfolder-name\u003e -T alphagov/tech-docs-template`\n- Change directory into the new website `cd \u003cfolder-name\u003e`\n- Install packages that the website requires `rbenv exec bundle install`\n- Change the contents of the file `config.rb` to the following\n    ```ruby\n    require 'govuk_tech_docs'\n\n    GovukTechDocs.configure(self)\n\n    configure :build do\n      activate :relative_assets\n    end\n    ```\n\n## Making changes\n\nTo make changes to the content of this website, edit files in the `source` folder of this repository.\n\nYou can add content by editing the `.html.md.erb` files. These files support content in:\n\n- Markdown\n- HTML\n- Ruby\n\n👉 You can use Markdown and HTML to [generate different content types][example-content] and [Ruby partials to manage content][partials].\n\n👉 Learn more about [producing more complex page structures][multipage] for your website.\n\n## Preview your changes locally\n\nIn your terminal:\n\n```\nmake init\nmake local-dev\n```\n\n👉 See the generated website on `http://localhost:4567` in your browser. Any content changes you make to your website will be updated in real time.\n\nTo shut down the Middleman instance running on your machine, use `ctrl+C`.\n\nIf you make changes to the `config/tech-docs.yml` configuration file, you need to restart Middleman to see the changes.\n\n## Build\n\nTo build the HTML pages from content in your `source` folder, run:\n\n```\nrbenv exec bundle exec middleman build\n```\n\nEvery time you run this command, the `build` folder gets generated from scratch. This means any changes to the `build` folder that are not part of the build command will get overwritten.\n\n## Troubleshooting\n\nDo not run `bundle update` because the website only builds with the current\npackage versions, given the old version of ruby.  You could try using a more\nrecent version of ruby, and recent versions of all the packages.\n\nRun `rbenv exec bundle exec middleman build --verbose` to get detailed error messages to help with finding the problem.\n\n## Licence\n\nUnless stated otherwise, the codebase is released under [the MIT License][mit].\nThis covers both the codebase and any sample code in the documentation.\n\nThe documentation is [© Crown copyright][copyright] and available under the terms of the [Open Government 3.0][ogl] licence.\n\n[mit]: LICENCE\n[copyright]: http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/\n[ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/\n[mmt]: https://middlemanapp.com/advanced/project_templates/\n[tdt-docs]: https://tdt-documentation.london.cloudapps.digital\n[config]: https://tdt-documentation.london.cloudapps.digital/configuration-options.html#configuration-options\n[frontmatter]: https://tdt-documentation.london.cloudapps.digital/frontmatter.html#frontmatter\n[multipage]: https://tdt-documentation.london.cloudapps.digital/multipage.html#build-a-multipage-site\n[example-content]: https://tdt-documentation.london.cloudapps.digital/content.html#content-examples\n[partials]: https://tdt-documentation.london.cloudapps.digital/single_page.html#add-partial-lines\n[install-ruby]: https://tdt-documentation.london.cloudapps.digital/install_macs.html#install-ruby\n[install-middleman]: https://github.com/middleman/middleman?tab=readme-ov-file#installation\n[gem]: https://github.com/alphagov/tech-docs-gem\n[template]: https://github.com/alphagov/tech-docs-template\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphagov%2Fdata-community-tech-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falphagov%2Fdata-community-tech-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphagov%2Fdata-community-tech-docs/lists"}