{"id":19478120,"url":"https://github.com/snyk/driftctl-docs","last_synced_at":"2025-09-13T08:34:28.421Z","repository":{"id":37095707,"uuid":"339769023","full_name":"snyk/driftctl-docs","owner":"snyk","description":"Docs site for driftctl","archived":false,"fork":false,"pushed_at":"2025-04-11T08:12:28.000Z","size":27208,"stargazers_count":6,"open_issues_count":16,"forks_count":14,"subscribers_count":54,"default_branch":"main","last_synced_at":"2025-04-11T10:34:29.261Z","etag":null,"topics":["docs","docusaurus","driftctl","infrastructure-as-code","react"],"latest_commit_sha":null,"homepage":"https://docs.driftctl.com","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/snyk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-02-17T15:32:55.000Z","updated_at":"2025-04-11T08:10:39.000Z","dependencies_parsed_at":"2024-11-10T19:47:25.758Z","dependency_job_id":"9306404c-5a22-4d37-b386-f26453d3554f","html_url":"https://github.com/snyk/driftctl-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/snyk%2Fdriftctl-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snyk%2Fdriftctl-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snyk%2Fdriftctl-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snyk%2Fdriftctl-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snyk","download_url":"https://codeload.github.com/snyk/driftctl-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250834261,"owners_count":21494937,"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":["docs","docusaurus","driftctl","infrastructure-as-code","react"],"created_at":"2024-11-10T19:47:12.124Z","updated_at":"2025-04-25T14:32:53.136Z","avatar_url":"https://github.com/snyk.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documentation website for driftctl\n\nhttps://docs.driftctl.com\n\nThis website is built using [Docusaurus 3](https://docusaurus.io/blog/releases/3.0), a static site generator for documentation sites.\n\n## Get Started\n\n1. Make sure all the dependencies for the website are installed:\n\n```shell\n# Install dependencies\n$ npm install\n```\n\n2. Run your dev server:\n\n```shell\n# Start the site\n$ npm start\n```\n\nThis starts a server hosting the website locally at http://localhost:3000/. Any changes to the site's source files are reflected after refreshing the page, i.e. the server does not need to be restarted to show changes.\n\n## Documentation\n\nAt the root of the repository, the `docs` directory is used to hold documentation written in Markdown. The front matter of new documentation files should at least follow this example:\n\n```yaml\n---\nid: doc-markdown\ntitle: Markdown File\n---\n\n```\n\nFor more attributes of the front matter, click [here](https://v2.docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-content-docs#markdown-frontmatter)\n\nThe docs are published to `https://docs.driftctl.com/next/` and are considered to be the docs of the next (not yet released) version of driftctl. When a release happens, the docs are copied to the `website/versioned_docs/version-\u003cversion\u003e` directory, whose content is published to `https://docs.driftctl.com`.\n\n## Static Build\n\nTo create a static build of the website:\n\n```shell\n# Build the site\n$ npm run build\n```\n\nThe result will be put in `build/`.\n\n## Contributing\n\nShould you wish to make a contribution please open a pull request against this repository with a clear description of the change with tests demonstrating the functionality. \nYou will also need to agree to the [Contributor Agreement](https://gist.github.com/201fc2fd188b4a68973998ec30b57686) before the code can be accepted and merged.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnyk%2Fdriftctl-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnyk%2Fdriftctl-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnyk%2Fdriftctl-docs/lists"}