https://github.com/open-cluster-management-io/open-cluster-management-io.github.io

website code of open-cluster-management project
https://github.com/open-cluster-management-io/open-cluster-management-io.github.io

Last synced: 2 days ago
JSON representation

website code of open-cluster-management project

• Host: GitHub
• URL: https://github.com/open-cluster-management-io/open-cluster-management-io.github.io
• Owner: open-cluster-management-io
• License: apache-2.0
• Created: 2020-10-26T01:35:21.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-17T16:53:03.000Z (7 months ago)
• Last Synced: 2024-05-17T17:57:46.874Z (7 months ago)
• Language: HTML
• Size: 44.4 MB
• Stars: 16
• Watchers: 4
• Forks: 67
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Website

This repo host the website code of open-cluster-management project. After the PR is merged, the compiled website page will be published to gh-page branch in this repo.

The open-cluster-management website is based on the [Hugo framework](https://github.com/gohugoio/hugo), with the [Docsy](https://www.docsy.dev/) applied, and is written in Markdown format.

You can always click the Edit this page link at the top right of each page, but if you want to test your changes locally before submitting you can:

Fork the open-cluster-management-io/open-cluster-management-io.github.io on GitHub.

Check out your copy locally:

```

git clone ssh://[email protected]//open-cluster-management-io.github.io.git

cd open-cluster-management-io.github.io

hugo server

```

An instance of the website is now running locally on your machine and is accessible at http://localhost:1313.

Edit files in src. The browser should automatically reload so you can view your changes.

When you are done with your edit(s) then commit, push, and submit a pull-request for your changes.

Your changes will be verified by CI. Check the job results for details of any errors.

## Special Note

We're also using the website to redirect requests targeting `open-cluster-management.io` to `github.com/open-cluster-management-io`, you can find more details in this [PR](https://github.com/open-cluster-management-io/open-cluster-management-io.github.io/pull/430).

If allows developers to use commands like `go get open-cluster-management.io/` and also use `open-cluster-management.io/` as the import path in go.mod.