{"id":22787369,"url":"https://github.com/aserto-dev/aserto-docs","last_synced_at":"2025-04-15T23:38:59.325Z","repository":{"id":37079641,"uuid":"403420513","full_name":"aserto-dev/aserto-docs","owner":"aserto-dev","description":"Public documentation for Aserto, hosted on docs.aserto.com","archived":false,"fork":false,"pushed_at":"2025-02-25T21:34:36.000Z","size":58228,"stargazers_count":7,"open_issues_count":1,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T02:42:00.931Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/aserto-dev.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}},"created_at":"2021-09-05T21:56:16.000Z","updated_at":"2025-02-25T21:34:40.000Z","dependencies_parsed_at":"2024-11-05T15:28:22.261Z","dependency_job_id":null,"html_url":"https://github.com/aserto-dev/aserto-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Faserto-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Faserto-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Faserto-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aserto-dev%2Faserto-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aserto-dev","download_url":"https://codeload.github.com/aserto-dev/aserto-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249173059,"owners_count":21224481,"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-12T00:54:53.267Z","updated_at":"2025-04-15T23:38:59.308Z","avatar_url":"https://github.com/aserto-dev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Aserto Docs\n\nThis is the source repo for the Aserto documentation [site](https://doc.aserto.com/).\n\nThis static documentation site is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.\n\n### Installation\n\n```\n$ yarn\n```\n\n### Local Development\n\n```\n$ yarn start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Build\n\n```\n$ yarn build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service. To serve it locally, use:\n\n```\n$ yarn serve\n```\n\nThis will serve the React bundle built in the `build` directory.\n\n### GraphQL API Reference\n\nReference documentation for the GraphQL API of the Aserto Directory is generated from the schema defined in the\n[directory](http://github.com/aserto-dev/directory) repo.\n\nTo regenerate the docs:\n\n1. Clone the [directory](http://github.com/aserto-dev/directory) repo if you don't have it.\n2. Checkout the `main` branch.\n3. Run `DIR_REPO=\u003cpath to directory repo\u003e yarn gqlgen`\n\nFor example, if you cloned the directory repo into `~/src/aserto-dev/directory`, then the command would be:\n\n        DIR_REPO=~/src/aserto-dev/directory yarn gqlgen\n\n\nThe command doesn't regenerate docs if the API schema hasn't changed since the last run. To force regeneration use the\n`-f` flag:\n\n        DIR_REPO=~/src/aserto-dev/directory yarn gqlgen -f\n\nThe generated content is placed in `docs/directory-guide/graphql/reference/schema`.\n\n## Deployment\n\nThe main branch is built and deployed with Netlify to https://docs.aserto.com.\n\n## Contributions\n\nTo contribute a change, open a PR against the main branch. Once merged, it will automatically be deployed.\n\n## Algolia search\n\n`scripts/scrape.sh` contains a script that scrapes the doc site to an Algolia account.\n\nFrom the room directory of the project, run:\n\n```\n$ yarn scrape\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faserto-dev%2Faserto-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faserto-dev%2Faserto-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faserto-dev%2Faserto-docs/lists"}