{"id":22520861,"url":"https://github.com/datum-cloud/docs","last_synced_at":"2025-04-14T14:21:28.737Z","repository":{"id":264106606,"uuid":"888654496","full_name":"datum-cloud/docs","owner":"datum-cloud","description":"Datum Cloud Documentation","archived":false,"fork":false,"pushed_at":"2025-04-09T01:49:48.000Z","size":1022,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-11T20:47:19.134Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/datum-cloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2024-11-14T19:17:31.000Z","updated_at":"2025-04-11T19:01:43.000Z","dependencies_parsed_at":"2025-01-20T04:22:59.295Z","dependency_job_id":"1fb6a1e5-d061-49b6-9d61-9a231122f25a","html_url":"https://github.com/datum-cloud/docs","commit_stats":null,"previous_names":["datum-cloud/docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datum-cloud%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datum-cloud%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datum-cloud%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datum-cloud%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datum-cloud","download_url":"https://codeload.github.com/datum-cloud/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248894939,"owners_count":21179154,"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-12-07T05:08:47.018Z","updated_at":"2025-04-14T14:21:28.695Z","avatar_url":"https://github.com/datum-cloud.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Datum Cloud Documentation\n\nThis repository contains the assets required to build the [Datum Documentation Website](https://docs.datum.net).\n\n## Running the website\n\n### Use hugo directly\n\nBuilding and running the site locally requires a recent `extended` version of\n[Hugo](https://gohugo.io). You can find out more about how to install Hugo for\nyour environment in the Docsy [Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation)\nguide.\n\nOnce you've made your working copy of the site repo, from the repo root folder,\nrun:\n\n```bash\nhugo server\n```\n\n### Run hugo in a container\n\nYou can run the docs site inside a [Docker](https://docs.docker.com/)\ncontainer, the container runs with a volume bound to the `docs`\nfolder. This approach doesn't require you to install any dependencies other\nthan [Docker Desktop](https://www.docker.com/products/docker-desktop) on\nWindows and Mac, and [Docker Compose](https://docs.docker.com/compose/install/)\non Linux.\n\n1. Build and run the docs\n\nWhen you run the following command, Docker Compose will automatically build the image if it doesn’t already exist (or if changes are detected in the Dockerfile or build context).\n\n```bash\ndocker compose up\n```\n\n2. Verify that the service is working.\n\n   Open your web browser and type `http://localhost:1313` in your navigation bar,\n   This opens a local instance of the docs homepage. You can now make\n   changes to the documentation and those changes will immediately show up in your\n   browser after you save.\n\n### Cleanup\n\nTo stop Docker Compose, on your terminal window, press **Ctrl + C**.\n\nTo remove the produced images run:\n\n```bash\ndocker compose rm\n```\n\nFor more information see the [Docker Compose documentation][].\n\n## Troubleshooting\n\nAs you run the website locally, you may run into the following error:\n\n```console\n$ hugo server\nWARN 2023/06/27 16:59:06 Module \"project\" is not compatible with this Hugo version; run \"hugo mod graph\" for more information.\nStart building sites …\nhugo v0.101.0-466fa43c16709b4483689930a4f9ac8add5c9f66+extended windows/amd64 BuildDate=2022-06-16T07:09:16Z VendorInfo=gohugoio\nError: Error building site: \"C:\\Users\\foo\\path\\to\\docsy-example\\content\\en\\_index.md:5:1\": failed to extract shortcode: template for shortcode \"blocks/cover\" not found\nBuilt in 27 ms\n```\n\nThis error occurs if you are running an outdated version of Hugo. As of docsy\ntheme version `v0.7.0`, hugo version `0.110.0` or higher is required. See this\n[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo)\nof the user guide for instructions on how to install Hugo.\n\nOr you may be confronted with the following error:\n\n```console\n$ hugo server\n\nINFO 2021/01/21 21:07:55 Using config file:\nBuilding sites … INFO 2021/01/21 21:07:55 syncing static files to /\nBuilt in 288 ms\nError: Error building site: TOCSS: failed to transform \"scss/main.scss\" (text/x-scss): resource \"scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68\" not found in file cache\n```\n\nThis error occurs if you have not installed the extended version of Hugo. See\nthis\n[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-hugo)\nof the user guide for instructions on how to install Hugo.\n\nOr you may encounter the following error:\n\n```console\n$ hugo server\n\nError: failed to download modules: binary with name \"go\" not found\n```\n\nThis error occurs if the `go` programming language is not available on your\nsystem. See this\n[section](https://www.docsy.dev/docs/get-started/docsy-as-module/installation-prerequisites/#install-go-language)\nof the user guide for instructions on how to install `go`.\n\n[Docker Compose documentation]: https://docs.docker.com/compose/gettingstarted/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatum-cloud%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatum-cloud%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatum-cloud%2Fdocs/lists"}