{"id":18510678,"url":"https://github.com/operator-framework/olm-docs","last_synced_at":"2025-06-20T03:39:11.798Z","repository":{"id":40461720,"uuid":"249754782","full_name":"operator-framework/olm-docs","owner":"operator-framework","description":"Hugo doc site for https://github.com/operator-framework/operator-lifecycle-manager","archived":false,"fork":false,"pushed_at":"2025-06-17T05:13:45.000Z","size":12916,"stargazers_count":10,"open_issues_count":35,"forks_count":83,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-06-17T05:29:05.240Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"SCSS","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/operator-framework.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-03-24T16:07:46.000Z","updated_at":"2025-06-17T05:13:43.000Z","dependencies_parsed_at":"2023-01-24T01:16:18.578Z","dependency_job_id":"f74c2312-895f-46fc-847b-ea8cfcf51877","html_url":"https://github.com/operator-framework/olm-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/operator-framework/olm-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operator-framework%2Folm-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operator-framework%2Folm-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operator-framework%2Folm-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operator-framework%2Folm-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/operator-framework","download_url":"https://codeload.github.com/operator-framework/olm-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operator-framework%2Folm-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260874295,"owners_count":23075797,"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-11-06T15:24:23.734Z","updated_at":"2025-06-20T03:39:06.790Z","avatar_url":"https://github.com/operator-framework.png","language":"SCSS","readme":"# OLM Documentation\n\nWe use [Hugo](https://gohugo.io/) to format and generate our website, the\n[Docsy](https://github.com/google/docsy) theme for styling and site structure,\nand [Netlify](https://www.netlify.com/) to manage the deployment of the site.\nHugo is an open-source static site generator that provides us with templates,\ncontent organisation in a standard directory structure, and a website generation\nengine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.\n\nAll submissions, including submissions by project members, require review. We\nuse GitHub pull requests for this purpose. Consult\n[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more\ninformation on using pull requests.\n\n## Quick start with Netlify\n\nHere's a quick guide to updating the docs. It assumes you're familiar with the\nGitHub workflow and you're happy to use the automated preview of your doc\nupdates:\n\n1. Fork [olm-docs](https://github.com/operator-framework/olm-docs) on GitHub.\n1. Make your changes and send a pull request (PR).\n1. If you're not yet ready for a review, create a draft PR to indicate it's a work in progress. (**Don't** add the Hugo property\n  \"draft = true\" to the page front matter, because that prevents the\n  auto-deployment of the content preview described in the next point.)\n1. Wait for the automated PR workflow to do some checks. When it's ready,\n  you should see a comment like this: **deploy/netlify — Deploy preview ready!**\n1. Click **Details** to the right of \"Deploy preview ready\" to see a preview\n  of your updates.\n1. Continue updating your doc and pushing your changes until you're happy with\n  the content.\n1. When you're ready for a review, remove any \"WIP\" markers and mark PR ready for review.\n\n## Updating a single page\n\nIf you've just spotted something you'd like to change while using the docs, Docsy has a shortcut for you:\n\n1. Click **Edit this page** in the top right hand corner of the page.\n1. If you don't already have an up to date fork of the project repo, you are prompted to get one - click **Fork this repository and propose changes** or **Update your Fork** to get an up to date version of the project to edit. The appropriate page in your fork is displayed in edit mode.\n1. Follow the rest of the [Quick start with Netlify](#quick-start-with-netlify) process above to make, preview, and propose your changes.\n\n## Previewing your changes locally\n\nIf you want to run your own local Hugo server to preview your changes as you work follow [this guide](/content/en/docs/contribution-guidelines/local-docs.md).\n\n## Creating an issue\n\nIf you've found a problem in the docs, but you're not sure how to fix it yourself, please create an issue in the [olm-docs repo](https://github.com/operator-framework/olm-docs). You can also create an issue about a specific page by clicking the **Create Issue** button in the top right hand corner of the page.\n\n## Useful resources\n\n* [Docsy user guide](https://www.docsy.dev/docs/): All about Docsy, including how it manages navigation, look and feel, and multi-language support.\n* [Hugo documentation](https://gohugo.io/documentation/): Comprehensive reference for Hugo.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foperator-framework%2Folm-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foperator-framework%2Folm-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foperator-framework%2Folm-docs/lists"}