{"id":19321273,"url":"https://github.com/academysoftwarefoundation/opencue.io","last_synced_at":"2025-02-24T05:24:53.340Z","repository":{"id":42494721,"uuid":"168053548","full_name":"AcademySoftwareFoundation/opencue.io","owner":"AcademySoftwareFoundation","description":"Source for OpenCue website","archived":false,"fork":false,"pushed_at":"2025-02-06T23:51:41.000Z","size":18297,"stargazers_count":18,"open_issues_count":20,"forks_count":27,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-02-07T00:27:04.332Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.opencue.io","language":"HTML","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/AcademySoftwareFoundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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}},"created_at":"2019-01-28T23:14:07.000Z","updated_at":"2025-02-06T23:51:45.000Z","dependencies_parsed_at":"2024-05-04T00:29:47.209Z","dependency_job_id":"db93a4a2-b25b-4a38-a8ed-28c6772b2777","html_url":"https://github.com/AcademySoftwareFoundation/opencue.io","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/AcademySoftwareFoundation%2Fopencue.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcademySoftwareFoundation%2Fopencue.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcademySoftwareFoundation%2Fopencue.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcademySoftwareFoundation%2Fopencue.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AcademySoftwareFoundation","download_url":"https://codeload.github.com/AcademySoftwareFoundation/opencue.io/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240422495,"owners_count":19798766,"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-10T01:36:25.064Z","updated_at":"2025-02-24T05:24:53.317Z","avatar_url":"https://github.com/AcademySoftwareFoundation.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenCue documentation\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/bef98bd8-69d2-4c22-a49e-c1c3897638ac/deploy-status)](https://app.netlify.com/sites/elated-haibt-1b47ff/deploys)\n\nWelcome to the repository for the OpenCue documentation and website. This\nrepository hosts all the code and resources to build the OpenCue\ndocumentation and website. We welcome contributions to the docs.\n\n## Contributing to the documentation\n\nThis section describes the process you need to follow, and the tools you need to\nrun, to propose changes to the OpenCue documentation.\n\n### Before you begin\n\nTo learn about the process for contributing to OpenCue, see\n[Contributing to OpenCue](https://www.opencue.io/contributing/opencue/contributing/). This page\nprovides additional help and information about contributing to the OpenCue documentation.\n\nAs with all changes to OpenCue, you also need to be familiar with common Git\nworkflows.\n\n### Website infrastructure\n\nWe run [Hugo](https://gohugo.io/) to generate the OpenCue website. The site\nimplements the Hugo [Docsy theme](https://github.com/google/docsy) to provide\nsite structure and styling. The OpenCue website is managed and hosted on\n[Netlify](https://www.netlify.com/).\n\nOpenCue documentation is written in Markdown. To publish the site, we run Hugo\nto generate HTML content.\n\n### Proposing changes\n\nOn most existing website pages, click **Edit this page** to propose simple\nchanges to the documentation. You can then edit the Markdown for that page using\nthe GitHub online editor and create a new branch to commit your changes and\nstart a pull request.\n\nFor larger changes, such as proposing a new page, or proposing changes to the\nsite homepage, you can clone and set up a local copy of the repository. To\npreview your changes locally on your development machine, you need to install a\nnumber of dependencies, such as Git and the extended version of Hugo. For more\ninformation, see the [Docsy documentation](https://github.com/google/docsy).\n\nTo set up a local copy of the OpenCue website:\n\n1. Make sure NPM (Node Package Manager) is installed on your system.\n\n1.  Follow these steps to [install Hugo](https://gohugo.io/getting-started/installing/) for your operating system.\n    Or, you can follow these steps to [install from binaries](https://github.com/gohugoio/hugo/releases).\n\n1.  Clone the opencue.io repository:\n\n    ```shell\n    git clone https://github.com/AcademySoftwareFoundation/opencue.io.git\n    ```\n\n1.  Change to the `opencue.io` directory:\n\n    ```shell\n    cd opencue.io\n    ```\n\n1.  Recursively update all Git submodules in the repository to install Docsy and\n    related dependencies:\n\n    **NOTE:** Docsy relies on additional submodules, such as Bootstrap. If you\n    skip this step, the `hugo` command fails.\n\n    ```shell\n    git submodule update --init --recursive\n    ```\n\n1.  Run the npm command to install any required Node.js dependencies:\n\n    ```\n    npm install\n    ```\n  \n1. Install `AutoPrefixer` to parse the CSS files:\n\n    ```shell\n   npm install autoprefixer\n     ```\n\n1. Install `PostCSS` so that the site build can create the final CSS assets:\n\n    ```shell\n   npm install postcss-cli\n     ```\n\n1.  Run the `hugo` command to verify the installation steps were successful:\n\n    ```\n    hugo\n    ```\n    \n1. Run the `hugo server` command to serve the static content and view it in your browser:   \n    \n     ```\n    hugo server\n    ```\n    \nYou can now create a Git branch in your copy of the repository to experiment\nwith making changes. To preview your changes in a browser, run the `hugo server`\ncommand. When you're ready to push your changes to the opencue.io repository,\ncreate a [pull request](https://help.github.com/en/articles/about-pull-requests).\n\n### Writing guidelines\n\nThe OpenCue documentation follows the\n[Google Developer Documentation Style Guide](https://developers.google.com/style/).\nAs with changes to the primary OpenCue repository, all changes to the\ndocumentation and website are peer-reviewed by project contributors.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facademysoftwarefoundation%2Fopencue.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facademysoftwarefoundation%2Fopencue.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facademysoftwarefoundation%2Fopencue.io/lists"}