https://github.com/cuba-platform/guides
CUBA platform guides
https://github.com/cuba-platform/guides
Last synced: about 1 year ago
JSON representation
CUBA platform guides
- Host: GitHub
- URL: https://github.com/cuba-platform/guides
- Owner: cuba-platform
- License: apache-2.0
- Created: 2018-10-05T13:24:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-18T13:37:04.000Z (over 3 years ago)
- Last Synced: 2025-04-08T07:18:16.803Z (over 1 year ago)
- Language: CSS
- Homepage:
- Size: 76.8 MB
- Stars: 7
- Watchers: 3
- Forks: 7
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CUBA Platform guides
This project contains the the sources for the CUBA Platform guides provided on https://cuba-platform.com/guides
## Creating a guide
1. create a file in `_drafts` directory (a good starting point is `guide-template.adoc`).
2. write the guide
## How guides will be deployed
Every 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/).
The 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.
## Running locally
In order to run locally, it is required to have the [Jekyll](https://jekyllrb.com/) based environment running.
### required environment
Mainly following the setup instructions on: https://jekyllrb.com/docs/#instructions
After `ruby`, `jeykll` and `bundler` is installed, execute `bundle install` in the project directory to get all required dependencies.
### running Jekyll locally
With that everything is setup in order to run `jekyll` locally
```
$ jekyll serve --config _config.yml
```
Then http://127.0.0.1:4000/ will serve the local guides
### running Jekyll locally with drafts
Normally it is useful to create the guide as a draft. In order to see them as well in the output, add the `--drafts` flag:
```
$ jekyll serve --drafts --config _config.yml
```
### Build Using Docker
Create builder image with required dependencies:
```
docker build -f docker/builder/Dockerfile -t cuba-platform/guides-builder .
```
Build:
```
docker run --rm --volume="$PWD:/srv/jekyll" cuba-platform/guides-builder jekyll build
```
Serve:
```
docker run --rm --volume="$PWD:/srv/jekyll" -p 4000:4000 cuba-platform/guides-builder jekyll serve
```