{"id":21430080,"url":"https://github.com/cuba-platform/guides","last_synced_at":"2025-07-14T11:31:07.073Z","repository":{"id":45429657,"uuid":"151724341","full_name":"cuba-platform/guides","owner":"cuba-platform","description":"CUBA platform guides","archived":false,"fork":false,"pushed_at":"2022-11-18T13:37:04.000Z","size":80503,"stargazers_count":7,"open_issues_count":7,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-08T07:18:16.803Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CSS","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/cuba-platform.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}},"created_at":"2018-10-05T13:24:53.000Z","updated_at":"2022-11-18T13:37:44.000Z","dependencies_parsed_at":"2023-01-23T07:45:58.949Z","dependency_job_id":null,"html_url":"https://github.com/cuba-platform/guides","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cuba-platform/guides","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuba-platform%2Fguides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuba-platform%2Fguides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuba-platform%2Fguides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuba-platform%2Fguides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cuba-platform","download_url":"https://codeload.github.com/cuba-platform/guides/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuba-platform%2Fguides/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265285207,"owners_count":23740483,"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-22T22:20:35.284Z","updated_at":"2025-07-14T11:31:02.061Z","avatar_url":"https://github.com/cuba-platform.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CUBA Platform guides\n\nThis project contains the the sources for the CUBA Platform guides provided on https://cuba-platform.com/guides\n\n\n## Creating a guide\n\n1. create a file in `_drafts` directory (a good starting point is `guide-template.adoc`).\n2. write the guide\n\n## How guides will be deployed\n\nEvery guide that is under `_posts` in the master branch of this project will get picked up as a guide and be served by [Github pages](https://pages.github.com/).\n\nThe normal workflow is to create a not-complete guide in the `_drafts` directory as well as using PRs in this repository when it comes to releasing a guide.\n\n## Running locally\n\nIn order to run locally, it is required to have the [Jekyll](https://jekyllrb.com/) based environment running.\n\n### required environment\n\nMainly following the setup instructions on: https://jekyllrb.com/docs/#instructions\n\nAfter `ruby`, `jeykll` and `bundler` is installed, execute `bundle install` in the project directory to get all required dependencies.\n\n\n### running Jekyll locally\n\nWith that everything is setup in order to run `jekyll` locally\n\n```\n$ jekyll serve --config _config.yml\n```\n\nThen http://127.0.0.1:4000/ will serve the local guides\n\n### running Jekyll locally with drafts\n\nNormally it is useful to create the guide as a draft. In order to see them as well in the output, add the `--drafts` flag:\n\n```\n$ jekyll serve --drafts --config _config.yml \n```\n\n### Build Using Docker \n\nCreate builder image with required dependencies: \n\n```\ndocker build -f docker/builder/Dockerfile -t cuba-platform/guides-builder . \n```\n\nBuild:\n\n```\ndocker run --rm --volume=\"$PWD:/srv/jekyll\" cuba-platform/guides-builder jekyll build\n```\n\nServe:\n\n```\ndocker run --rm --volume=\"$PWD:/srv/jekyll\" -p 4000:4000 cuba-platform/guides-builder jekyll serve\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcuba-platform%2Fguides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcuba-platform%2Fguides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcuba-platform%2Fguides/lists"}