{"id":28615867,"url":"https://github.com/stacklok/docs-website","last_synced_at":"2025-06-12T02:10:39.698Z","repository":{"id":297679860,"uuid":"997038133","full_name":"stacklok/docs-website","owner":"stacklok","description":"Stacklok user documentation website","archived":false,"fork":false,"pushed_at":"2025-06-06T19:42:59.000Z","size":3599,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-06T20:25:00.762Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.stacklok.com","language":"CSS","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/stacklok.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,"zenodo":null}},"created_at":"2025-06-05T21:17:48.000Z","updated_at":"2025-06-06T19:42:59.000Z","dependencies_parsed_at":"2025-06-06T20:38:31.802Z","dependency_job_id":null,"html_url":"https://github.com/stacklok/docs-website","commit_stats":null,"previous_names":["stacklok/docs-website"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/stacklok/docs-website","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacklok%2Fdocs-website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacklok%2Fdocs-website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacklok%2Fdocs-website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacklok%2Fdocs-website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stacklok","download_url":"https://codeload.github.com/stacklok/docs-website/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stacklok%2Fdocs-website/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259382356,"owners_count":22848845,"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":"2025-06-12T02:10:28.579Z","updated_at":"2025-06-12T02:10:39.673Z","avatar_url":"https://github.com/stacklok.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Stacklok docs \u003c!-- omit in toc --\u003e\n\n[![GitHub deployments](https://img.shields.io/github/deployments/stacklok/docs-website/Production?logo=vercel\u0026style=flat\u0026label=Vercel%20deployment)](https://github.com/stacklok/docs-website/deployments/Production)\n\nThis repository contains the public-facing docs for Stacklok's projects, hosted\nat [https://docs.stacklok.com](https://docs.stacklok.com).\n\n- [Contributing to docs](#contributing-to-docs)\n- [Local development](#local-development)\n- [Formatting](#formatting)\n- [Building the site](#building-the-site)\n- [Deployment](#deployment)\n- [About](#about)\n\n## Contributing to docs\n\nWe welcome contributions to the Stacklok documentation - if you find something\nmissing, wrong, or unclear, please let us know via an issue or open a PR!\n\nPlease review the [style guide](./STYLE-GUIDE.md) for help with voice, tone, and\nformatting.\n\n## Local development\n\nYou'll need Node.js available (v22 recommended) or VS Code with the\n[Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)\nextension and Docker.\n\n[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers\u0026message=Open\u0026color=blue)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/stacklok/docs-website)\n\n```bash\nnpm install\nnpm run start\n```\n\nThis command starts a local development server on port 3000 and opens a browser\nwindow to \u003chttp://localhost:3000\u003e. Most changes are reflected live without\nhaving to restart the server.\n\n## Formatting\n\nWe use a combination of Prettier, markdownlint, and ESLint to normalize\nformatting and syntax. Before you submit a PR, please check for issues:\n\n```bash\nnpm run prettier\nnpm run markdownlint\nnpm run eslint\n```\n\nTo automatically fix issues:\n\n```bash\nnpm run prettier:fix\nnpm run markdownlint:fix\nnpm run eslint:fix\n```\n\nThe formatting commands also run as a pre-commit hook using\n[Husky](https://typicode.github.io/husky/), so commits will fail if there are\nformatting issues that can't be fixed automatically. You can skip this by using\n`git commit --no-verify`, but it's recommended to fix the issues instead since\nthe P workflow will fail the checks anyway.\n\n## Building the site\n\n```bash\nnpm run build\n```\n\nThis command generates static content into the `build` directory. It also checks\nfor broken links, so it's recommended to run this before submitting a PR.\n\n## Deployment\n\nThe `docs.stacklok.com` site is published using Vercel. Automatic previews for\nbranches and pull requests are enabled. The production site is published from\nthe `main` branch.\n\n## About\n\nThis site is built with [Docusaurus](https://docusaurus.io/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstacklok%2Fdocs-website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstacklok%2Fdocs-website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstacklok%2Fdocs-website/lists"}