{"id":14156492,"url":"https://github.com/score-spec/docs","last_synced_at":"2025-12-10T14:30:15.632Z","repository":{"id":173007865,"uuid":"563583381","full_name":"score-spec/docs","owner":"score-spec","description":"Docs for Score Specification. ","archived":false,"fork":false,"pushed_at":"2024-10-29T13:06:10.000Z","size":22591,"stargazers_count":6,"open_issues_count":8,"forks_count":12,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-29T15:56:30.455Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.score.dev/docs/","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/score-spec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2022-11-08T23:05:09.000Z","updated_at":"2024-10-29T13:06:15.000Z","dependencies_parsed_at":"2023-10-25T15:53:59.880Z","dependency_job_id":"c8d17673-1f83-4f45-a06b-63ce3d132b87","html_url":"https://github.com/score-spec/docs","commit_stats":null,"previous_names":["score-spec/docs"],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/score-spec%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/score-spec%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/score-spec%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/score-spec%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/score-spec","download_url":"https://codeload.github.com/score-spec/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239671416,"owners_count":19677873,"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-08-17T08:05:31.659Z","updated_at":"2025-12-10T14:30:15.602Z","avatar_url":"https://github.com/score-spec.png","language":"HTML","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"[![release](https://github.com/score-spec/docs/actions/workflows/hugo.yml/badge.svg)](https://github.com/score-spec/docs/actions/workflows/hugo.yml) [![good first issue](https://img.shields.io/github/issues-search/score-spec/docs?query=type%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22\u0026label=good%20first%20issues\u0026style=flat\u0026logo=github)](https://github.com/score-spec/docs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)\n\n![Score banner](/images/banner.png)\n\n## Docs\n\nThis section covers how to build the documentation site with Hugo.\nFor information on Score's style guide see the [Style guide](styles/style-guide.md).\n\n### Running the website locally\n\n#### `yarn`\n\nWe use `yarn` (for MacOS: `brew install yarn`) as a package manager to ensure the versions of Hugo and associated tools are up to date. All commands that execute those tools are prefixed with `yarn run` or are aliased in the `package.json` file.\n\nTo install the packages:\n\n```\nyarn install\n```\n\nTo run the server locally:\n\n```\nyarn build\n\nOR\n\nyarn run hugo server\n```\n\nAnd then view it at \u003chttp://localhost:1313\u003e.\n\n#### `score-compose`\n\nYou can [install `score-compose`](https://docs.score.dev/docs/score-implementation/score-compose/installation/) and then build and run this hugo website as a container:\n\n```\nscore-compose init --no-sample\nscore-compose generate score.yaml --build main=.\n\ndocker compose up --build -d\n\ncurl $(score-compose resources get-outputs dns.default#score-docs.dns --format '{{ .host }}:8080/docs/')\n```\n\n### Deployment\n\nThis site is currently deployed through Github Pages with a CNAME directing `docs.score.dev` to `score-spec.github.io`. The DNS configuration is managed by Humanitec.\n\n### Format docs\n\nThe following section covers how to format and lint prose.\n\n### Formatters and linters\n\nThis project uses the [dprint](https://dprint.dev/overview/) to format documentation. dprint is a command line application that automatically formats code.\n\nUse `dprint` to format your documentation.\n\n```bash\nyarn fmt\n```\n\nExample output.\n\n```bash\n$ yarn fmt\nFormatted 1 file.\n✨  Done in 0.13s.\n```\n\nThis project uses the [Vale](https://vale.sh) with a [Vale-compatible implementation of the Google Developer Documentation Style Guide](https://github.com/errata-ai/Google).\n\nOn MacOS, install it through `brew install vale`.\n\nFor example, to lint a document run:\n\n```bash\nvale sync\nvale styles/style-guide.md\n```\n\nExample output.\n\n```bash\n styles/style-guide.md\n 40:71  error  Did you really mean             Vale.Spelling \n               'inclusivity'?                                \n\n✖ 1 error, 0 warnings and 0 suggestions in 1 file.\n```\n\nTo lint all documents, run `yarn lint`.\n\n## Troubleshooting documentation site builds\n\nThis section covers common build issues with Hugo.\n\n### Failed to resolve output format `print`\n\nWhen building the server, you may receive the following error message.\n\n```bash\nError: from config: failed to resolve output format \"print\" from site config\nerror Command failed with exit code 255.\ninfo Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.\n```\n\nTo resolve this issue, delete the temporary Hugo cache directory. By default, [`-cacheDir`](https://gohugo.io/commands/hugo_server/) is stored at `$TMPDIR/hugo_cache`.\n\n```bash\nrm -rf $TMPDIR/hugo_cache\n```\n\n\u003c!-- https://github.com/google/docsy/issues/805#issuecomment-1245110883 --\u003e\n\n### `package-lock.json` locked files\n\nWhen running `yarn`, you may receive the following error message.\n\n```bash\nwarning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json.\n```\n\nTo resolve this issue, delete the `package-lock.json` file.\n\n```bash\nrm package-lock.json\n```\n\nYou can find our documentation at [docs.score.dev](https://docs.score.dev/docs/).\n\n### Contribute\n\nIf you have a suggestion to improve our documentation, please fork the repo and create a pull request. You can also open an issue with the tag `enhancement`.\n\n1. Fork the Project.\n2. Create your Feature Branch. `git checkout -b feature/feature-name`\n3. Commit your Changes. `git commit -s -m \"Add some amazing documentation enhancement\"`\n4. Push to the Branch. `git push origin feature/feature-name`\n5. Open a Pull Request.\n\nRead [CONTRIBUTING](CONTRIBUTING.md) for more information.\n\n### Roadmap\n\nSee [Roadmap](roadmap.md). You can [submit an idea](https://github.com/score-spec/spec/issues/new) anytime.\n\n### License\n\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\n### Code of conduct\n\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscore-spec%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscore-spec%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscore-spec%2Fdocs/lists"}