{"id":40141125,"url":"https://github.com/open-horizon/open-horizon.github.io","last_synced_at":"2026-01-19T14:30:37.570Z","repository":{"id":36984802,"uuid":"249248498","full_name":"open-horizon/open-horizon.github.io","owner":"open-horizon","description":"Open Horizon Web Site","archived":false,"fork":false,"pushed_at":"2026-01-12T21:35:54.000Z","size":45388,"stargazers_count":30,"open_issues_count":17,"forks_count":57,"subscribers_count":8,"default_branch":"master","last_synced_at":"2026-01-13T01:54:45.994Z","etag":null,"topics":["documentation","edge-computing","hacktoberfest","open-horizon"],"latest_commit_sha":null,"homepage":"https://open-horizon.github.io/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-horizon.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,"notice":null,"maintainers":"MAINTAINERS.md","copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-03-22T18:38:14.000Z","updated_at":"2026-01-12T21:35:52.000Z","dependencies_parsed_at":"2023-10-01T21:46:49.236Z","dependency_job_id":"a27107ce-44a1-422c-9aa3-88114361c466","html_url":"https://github.com/open-horizon/open-horizon.github.io","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/open-horizon/open-horizon.github.io","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-horizon%2Fopen-horizon.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-horizon%2Fopen-horizon.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-horizon%2Fopen-horizon.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-horizon%2Fopen-horizon.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-horizon","download_url":"https://codeload.github.com/open-horizon/open-horizon.github.io/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-horizon%2Fopen-horizon.github.io/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28571769,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T12:50:50.164Z","status":"ssl_error","status_checked_at":"2026-01-19T12:50:42.704Z","response_time":67,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","edge-computing","hacktoberfest","open-horizon"],"created_at":"2026-01-19T14:30:35.293Z","updated_at":"2026-01-19T14:30:37.563Z","avatar_url":"https://github.com/open-horizon.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp style=\"text-align:center;\" align=\"center\"\u003e\n  \u003cimg align=\"center\" src=\"https://github.com/open-horizon/open-horizon.github.io/blob/master/img/logos/open-horizon-color.png\" width=\"45%\"/\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/open-horizon/open-horizon.github.io\" alt=\"GitHub contributors\"\u003e\n\u003cimg src=\"https://img.shields.io/github/contributors/open-horizon/open-horizon.github.io.svg\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/open-horizon/open-horizon.github.io\" alt=\"Check_broken_link.yml\"\u003e\n\u003cimg src=\"https://github.com/open-horizon/open-horizon.github.io/actions/workflows/Check_broken_link.yml/badge.svg\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/open-horizon/open-horizon.github.io\" alt=\"Twitter Follow\"\u003e\n\u003cimg src=\"https://github.com/open-horizon/open-horizon.github.io/actions/workflows/orphan_pages_checker.yml/badge.svg\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://matrix.to/#/#open-horizon-docs:chat.lfx.linuxfoundation.org\" alt=\"chat on matrix\"\u003e\n\u003cimg src=\"https://matrix.to/img/matrix-badge.svg\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# Contributing to Open Horizon pages\n\nTo visit the Open Horizon documentation site, go to [open-horizon.github.io](https://open-horizon.github.io/)\n\nIf you would like to contribute to the project, read the following documentation for helpful information and guidelines.\n\n## How to contribute to Open Horizon\n\nAll content, artwork, and code is contained in GitHub repositories.  To see what assistance we need, look for open GitHub issues that have not been assigned to someone already.  If you see one that you would like to work on, please add a comment to that issue and try to `@mention` the person who opened the issue to let them know of your interest.  Do not begin working on an issue unless and until it has been assigned to you.  Likewise, do not submit a Pull Request (code fix or submission) unless it is tied to an existing open issue.\n\nMore details can be found on the following pages:\n\n* [Contribution Guidelines](https://github.com/open-horizon/.github/blob/master/CONTRIBUTING.md)\n* [The mechanics of working on an issue](https://open-horizon.github.io/common-requests/contribute/)\n* [Chat with the project team and ask any questions](https://chat.lfx.linuxfoundation.org/#/welcome)\n* [List all unassigned and open issues labelled \"Good First Issue\"](https://github.com/search?type=issues\u0026q=org%3Aopen-horizon+org%3Aopen-horizon-services+label%3A%22good+first+issue%22+is%3Aopen+no%3Aassignee)\n\nWe appreciate and recognize all Contributors.\n\n# Table of Contents\n\n- [Contributing to Open Horizon Pages](#contributing-to-open-horizon-pages)\n- [Table of Contents](#table-of-contents)\n- [Fork the Repository](#fork-the-repository)\n- [Make Necessary Changes](#make-necessary-changes)\n  - [Clone the repository](#clone-the-repository)\n  - [Create a branch](#create-a-branch)\n  - [Make necessary changes](#make-necessary-changes-1)\n  - [Identifying Documentation Source](#identifying-documentation-source)\n- [Test in Local and Push Changes to GitHub](#test-in-local-and-push-changes-to-github)\n  - [Prerequisites](#prerequisites)\n  - [Test your changes locally](#test-your-changes-locally)\n  - [Commit changes](#commit-changes)\n  - [Push changes to GitHub](#push-changes-to-github)\n  - [Possible errors](#possible-errors)\n- [Submit a Pull Request for Review](#submit-a-pull-request-for-review)\n- [Clean Up](#clean-up)\n  - [Delete the branch](#delete-the-branch)\n  - [Syncing a fork](#syncing-a-fork)\n\n# Fork the Repository\n\nFork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.\n\n# Make Necessary Changes\n\nTo make changes, clone the forked repository to your machine.\n\n## Clone the repository\n\n\u003cimg align=\"right\" width=\"300\" src=\"img/clone.jpg\" alt=\"clone this repository\"/\u003e\n\nGo to your GitHub account, open the forked repository, click **Code**, and then **copy to clipboard**.\n\nOpen a terminal and run the following git command:\n\n```bash\ngit clone \"url you just copied\"\n```\n\nwhere \"url you just copied\" (without the quotation marks) is the url to this repository (your fork of this project).\n\n## Create a branch\n\nChange to the repository directory on your computer:\n\n```bash\ncd open-horizon.github.io\n```\n\nNow create a branch using the `git checkout` command:\n\n```bash\ngit checkout -b \u003cname-your-new-branch-name-after-your-issue\u003e\n```\n\nFor example:\n\n```bash\ngit checkout -b issue-329\n```\n\n## Make necessary changes\n\nNow, you can suggest contributions, make necessary changes to existing files, or add new files.\n\n## Identifying Documentation Source\n\nSome markdown pages under [open-horizon.github.io/docs](https://github.com/open-horizon/open-horizon.github.io/tree/master/docs) can have their source markdown in other repositories in the Open Horizon GitHub organization.\n\nUse the URL path to identify if the source is [open-horizon.github.io/docs](https://github.com/open-horizon/open-horizon.github.io/tree/master/docs) or another repository. If the source is in different repository then sourced repo name is used `open-horizon.github.io/docs/\u003cSOURCE_REPO_NAME\u003e/docs`.\n\n- [`/docs/anax/docs/`](https://github.com/open-horizon/open-horizon.github.io/tree/master/docs/anax/docs) markdown pages are sourced from https://github.com/open-horizon/anax/tree/master/docs/\n- [`/docs/mgmt-hub/docs/`](https://github.com/open-horizon/open-horizon.github.io/tree/master/docs/mgmt-hub/docs/) markdown pages are sourced from https://github.com/open-horizon/devops/blob/master/docs/\n- [`/docs/kubearmor-integration/docs/`](https://github.com/open-horizon/open-horizon.github.io/tree/master/docs/kubearmor-integration/docs/) markdown pages are sourced from https://github.com/open-horizon/kubearmor-integration/tree/main/docs/\n\nIt is important that any changes to docs sourced from another repository be made in the corresponding repository and not in the `open-horizon.github.io` repository.\n\nCopyDocs GitHub Actions, in each of the respective repos, will trigger on a PR merge and the source markdown files will be copied.\n\n# Test in local and push changes to GitHub\n\nBefore you push changes to GitHub, build this GitHub pages site locally to preview and test the changes.\n\n## Prerequisites\n\nThis GitHub Pages site is built with Jekyll. Before you can use Jekyll to test a site, you must [install Jekyll](https://jekyllrb.com/docs/installation/).\n\n## Test your changes locally\n\n\u003e NOTE: Ruby 3.2.0 is [incompatible at the moment](https://www.miskatonic.org/2023/01/02/ruby-jekyll/).  Recommend using `rbenv` and installing and using `rbenv local 3.1.1` as a workaround.  On MacOS, `brew install rbenv` then `rbenv install 3.1.1` first.\n\nChange to the repository directory on your computer and execute the following command to run the Jekyll site locally.\n\n1. To install and update all dependencies.\n\n   ```bash\n   make init\n   ```\n\n   **Note**: Run the above command one time before using the tools each day.\n\n2. Start the local web server, do not build the site first\n\n   ```bash\n   make run\n   ```\n\n   **Note**: This runs a local web server with live reload enabled. When running the make command on Windows, an error might occur that identifies the installed command as unrecognized. This can happen when the binary path is set incorrectly.\n\n   To preview the site in your web browser navigate to [http://localhost:4000](http://localhost:4000).\n\n3. To build and test the local documentation site:\n\n   ```bash\n   make dev\n   ```\n\n4. To Build the local documentation site:\n\n   ```bash\n   make build\n   ```\n\n5. Test the local documentation site locally:\n\n   ```bash\n   make test\n   ```\n\n   **Note**: This is typically done before `make run`\n\n## Commit changes\n\nAfter you have a successful testing in local with your changes, you are ready to commit those changes.\n\nIf you go to the project directory and execute the command `git status`, you'll see your changes.\n\nAdd those changes to the branch you just created using the `git add` command:\n\n```bash\ngit add \u003cfile\u003e\n```\n\nAll commits should be signed off (`-s` flag on `git commit`). To use the `-s` option, follow the [guidance](common-requests/contribute.md#how-to-attest) to make sure you configure your git name (user.name) and email address (user.email).\n\nNow commit those changes using the git commit command:\n\n```bash\ngit commit -s -m \"Add README.md\"\n```\n\n## Push changes to GitHub\n\nPush your changes using the command `git push`:\n\n```bash\ngit push origin \u003cadd-your-branch-name\u003e\n```\n\nreplacing `\u003cadd-your-branch-name\u003e` with the name of the branch you created earlier.\n\n## Possible Errors\n\nWhen setting up a project locally, some errors can occur. Some of those are listed below.\n\n- Missing `webrick` and `wdm` in `Gemfile`\n\nChange to:\n\nSome users use the latest version of `ruby`, which is `\u003e2.7` that does not have pre-added `webrick` support. If they are using `ruby` versions `\u003e= 3.0.0`, they might see the error listed below.\n\n```text\n  Add the following to your Gemfile to avoid polling for changes:\n    gem 'wdm', '\u003e= 0.1.0' if Gem.win_platform?\n Auto-regeneration: enabled for 'C:/Users/yourUserName/Desktop/open-horizon/open-horizon.github.io'\nC:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/jekyll-3.9.0/lib/jekyll/commands/serve/servlet.rb:3:in `require': cannot load such file -- webrick (LoadError)\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/jekyll-3.9.0/lib/jekyll/commands/serve/servlet.rb:3:in `\u003ctop (required)\u003e'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/jekyll-3.9.0/lib/jekyll/commands/serve.rb:184:in `require_relative'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/jekyll-3.9.0/lib/jekyll/commands/serve.rb:184:in `setup'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/jekyll-3.9.0/lib/jekyll/commands/serve.rb:102:in `process'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/jekyll-3.9.0/lib/jekyll/commands/serve.rb:93:in `block in start'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/jekyll-3.9.0/lib/jekyll/commands/serve.rb:93:in `each'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/jekyll-3.9.0/lib/jekyll/commands/serve.rb:93:in `start'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/jekyll-3.9.0/lib/jekyll/commands/serve.rb:75:in `block (2 levels) in init_with_program'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/mercenary-0.3.6/lib/mercenary/command.rb:220:in `block in execute'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/mercenary-0.3.6/lib/mercenary/command.rb:220:in `each'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/mercenary-0.3.6/lib/mercenary/command.rb:220:in `execute'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/mercenary-0.3.6/lib/mercenary/program.rb:42:in `go'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/mercenary-0.3.6/lib/mercenary.rb:19:in `program'\n        from C:/Ruby30-x64/lib/ruby/gems/3.0.0/gems/jekyll-3.9.0/exe/jekyll:15:in `\u003ctop (required)\u003e'\n        from C:/Ruby30-x64/bin/jekyll:25:in `load'\n        from C:/Ruby30-x64/bin/jekyll:25:in `\u003cmain\u003e'\n```\n\nTo solve this error, add `webrick` and `wdm` to your local `Gemfile` by using the commands listed below and re-run the serve.\n\nadd webrick:\n\n```bash\nbundle add webrick\n```\n\nadd wdm:\n\n```bash\ngem install wdm\n```\n\n# Submit a Pull Request for Review\n\nIf you go to your repository on GitHub, you'll see a `Compare \u0026 pull request button`. Click on that button.\n\n\u003cimg style=\"float: right;\" src=\"img/compare-and-pull.jpg\" alt=\"create a pull request\"/\u003e\n\nNow submit the pull request by clicking `Create pull request`.\n\n\u003cimg style=\"float: right;\" src=\"img/submit-pull-request.jpg\" alt=\"submit pull request\"/\u003e\n\nYou will get a notification email after the changes have been merged.\n\n# Clean Up\n\n## Delete the branch\n\nAfter your Pull Request has been approved/merged, you are safe to delete the branch created earlier. Change to the repository directory on your computer and execute the following commands to delete the branch:\n\nDelete the local branch:\n\n```bash\ngit branch -d \u003cbranch-name\u003e\n```\n\nDelete remote branch:\n\n```bash\ngit push origin :\u003cbranch-name\u003e\n```\n\n## Syncing a fork\n\nConnect your local repository to the original, upstream repository by adding it as a remote. You should pull in changes from upstream often, so that you stay up-to-date. This helps avoid merge conflicts when you submit pull requests.\n\nFor more information, see [Sync a fork of a repository to keep it up-to-date with the upstream repository.](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)\n\n## 📌 Our valuable contributors👩‍💻👨‍💻\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ca href=\"https://github.com/open-horizon/open-horizon.github.io/graphs/contributors\"\u003e\n      \u003cimg src=\"https://contrib.rocks/image?repo=open-horizon/open-horizon.github.io\" /\u003e\n    \u003c/a\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-horizon%2Fopen-horizon.github.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-horizon%2Fopen-horizon.github.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-horizon%2Fopen-horizon.github.io/lists"}