{"id":13563874,"url":"https://github.com/prometheus/docs","last_synced_at":"2025-04-03T20:32:18.583Z","repository":{"id":24819493,"uuid":"28233924","full_name":"prometheus/docs","owner":"prometheus","description":"Prometheus documentation: content and static site generator","archived":false,"fork":false,"pushed_at":"2025-03-17T20:46:07.000Z","size":32503,"stargazers_count":679,"open_issues_count":270,"forks_count":1029,"subscribers_count":37,"default_branch":"main","last_synced_at":"2025-03-17T21:39:13.718Z","etag":null,"topics":["documentation","hacktoberfest","prometheus","prometheus-documentation"],"latest_commit_sha":null,"homepage":"https://prometheus.io","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/prometheus.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-12-19T15:06:35.000Z","updated_at":"2025-03-17T20:46:10.000Z","dependencies_parsed_at":"2024-04-02T10:33:22.697Z","dependency_job_id":"36c5aba2-0582-41ca-9119-c98b5950ba6d","html_url":"https://github.com/prometheus/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/prometheus%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prometheus%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prometheus%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prometheus%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prometheus","download_url":"https://codeload.github.com/prometheus/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247075254,"owners_count":20879419,"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":["documentation","hacktoberfest","prometheus","prometheus-documentation"],"created_at":"2024-08-01T13:01:24.180Z","updated_at":"2025-04-03T20:32:18.575Z","avatar_url":"https://github.com/prometheus.png","language":"HTML","funding_links":[],"categories":["TypeScript","SCSS"],"sub_categories":[],"readme":"# Prometheus Documentation\n\nThis repository contains both the content and the static-site generator code for the\nPrometheus documentation site.\n\n## Contributing Changes\n\nSee [`CONTRIBUTING.md`](CONTRIBUTING.md) for general instructions for new Prometheus contributors.\n\nThe main documentation contents of this website are located in the [`content/docs`](content/docs) directory.\n\nDocumentation concerning the Prometheus server is [maintained in the Prometheus server repository](https://github.com/prometheus/prometheus/tree/main/docs) and cloned into the website at build time.\n\nAs a guideline, please keep the documentation generally applicable and avoid use-case-specific changes.\n\n## Prerequisites\n\nYou need to have a working Ruby environment set up (including [bundler](https://bundler.io/))\nand then install the necessary gems:\n\n```bash\nmake bundle\n```\n\n## Building\n\nTo generate the static site, run:\n\n```bash\nmake build\n```\n\nThe resulting static site will be stored in the `output` directory.\n\nOptionally, you can use an API token to avoid rate limits on the API. You can get an API token from https://github.com/settings/tokens/new.\n```bash\nexport GITHUB_AUTHENTICATION='-u user:token'\n```\n\n## Development Server\n\nTo run a local server that displays the generated site, run:\n\n```bash\n# Rebuild the site whenever relevant files change:\nmake guard\n# Start the local development server in a separate shell:\nmake serve\n```\n\nYou should now be able to view the generated site at\n[http://localhost:3000/](http://localhost:3000).\n\n## Automatic Deployment\n\nThis site is automatically deployed using [Netlify](https://www.netlify.com/).\n\nIf you have the prerequisite access rights, you can view the Netlify settings here:\n\n* GitHub webhook notifying Netlify of branch changes: https://github.com/prometheus/docs/settings/hooks\n* Netlify project: https://app.netlify.com/sites/prometheus-docs\n\nChanges to the `main` branch are deployed to the main site at https://prometheus.io.\n\nNetlify also creates preview deploys for every pull request. To view these for a PR where all checks have passed:\n\n1. In the CI section of the PR, click on \"Show all checks\".\n2. On the \"deploy/netlify\" entry, click on \"Details\" to view the preview site for the PR.\n\nYou may have to wait a while for the \"deploy/netlify\" check to appear after creating or updating the PR, even if the other checks have already passed.\n\n## License\n\nApache License 2.0, see [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprometheus%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprometheus%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprometheus%2Fdocs/lists"}