{"id":21430182,"url":"https://github.com/cuba-platform/documentation","last_synced_at":"2025-03-17T15:12:23.915Z","repository":{"id":30106319,"uuid":"123926327","full_name":"cuba-platform/documentation","owner":"cuba-platform","description":"CUBA Platform Documentation","archived":false,"fork":false,"pushed_at":"2025-03-04T12:16:08.000Z","size":65306,"stargazers_count":26,"open_issues_count":117,"forks_count":43,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-04T13:23:15.872Z","etag":null,"topics":["cuba-platform","documentation","manual"],"latest_commit_sha":null,"homepage":"https://www.cuba-platform.com","language":"Java","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/cuba-platform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2018-03-05T13:51:25.000Z","updated_at":"2025-03-04T12:16:12.000Z","dependencies_parsed_at":"2024-11-22T22:33:22.364Z","dependency_job_id":null,"html_url":"https://github.com/cuba-platform/documentation","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/cuba-platform%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuba-platform%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuba-platform%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cuba-platform%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cuba-platform","download_url":"https://codeload.github.com/cuba-platform/documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244056425,"owners_count":20390719,"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":["cuba-platform","documentation","manual"],"created_at":"2024-11-22T22:21:24.735Z","updated_at":"2025-03-17T15:12:23.884Z","avatar_url":"https://github.com/cuba-platform.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CUBA Platform Documentation\n\n## Overview\n\nThe documentation is written in AsciiDoc format. Source files, images and includes are located in the `content` directory in the following subdirectories:\n\n* `manual` - Developer's Manual\n* `polymer` - Polymer UI Tutorial\n* `release_notes` - latest release notes\n* other subdirectories contain documentation on platform addons.\n\nMost of the documents have English and Russian versions in the corresponding subdirectories (`en` and `ru`). \n\nReleased documentation is available at [CUBA website](https://www.cuba-platform.com/documentation).\n\n## Building from Source\n\n### Prerequisites\n\nIn order to produce HTML from AsciiDoc, we use [Asciidoctor](https://asciidoctor.org). It can be installed as follows:\n \n1. Install [Ruby](https://www.ruby-lang.org/en/downloads) (tested on version 2.1).\n\n2. Install Asciidoctor:\n\n        gem install asciidoctor -v 1.5.2\n\n3. Install coderay for code highlighting:\n\n        gem install coderay\n\n4. If you want to generate PDF, install Asciidoctor PDF:\n\n        gem install asciidoctor-pdf -v 1.5.2\n\nThis is enough to build the documentation with the existing visual theme. If you want to change the theme, see the __Building Theme__ section below.\n\n### Build Tasks\n\nGradle is used as a build tool. Build task names have the following structure: `{purpose}{doc}{lang}`.\n\n__{purpose}__ can be one of the following:\n\n* `build` - build single-HTML document.\n* `chop` - build multi-page document.\n* `war` - build a WAR file. The resulting WAR file will have a name corresponding to the document name and a version which is set by the `ext.docVersion` property defined in `build.gradle`, for example `manual-7.0.war`.\n* `deploy` - deploy WAR to Tomcat (installed by the `setupTomcat` task, see below).\n* `pdf` - generate PDF.\n\n__{doc}__ is the document name (`Manual`, `Bpm`, etc.)\n\n__{lang}__ can be either `En` or `Ru`.\n\nFor example, to build and deploy the English manual, use the following command:\n\n    ./gradlew deployManualEn\n\nBefore running the deploy task, install the local Tomcat server by executing the following task:\n\n    ./gradlew setupTomcat\n    \nBy default, Tomcat is installed into `./deploy/tomcat` and configured to listen on port `6080`.\n\n### Building Theme\n\nThe CSS file containing the theme is located in the `styles` directory. Don't change this file - it must be built by the AsciiDoc theme builder. The theme builder is located in the `tools/asciidoctor-stylesheet-factory` directory (it is a copy of the [asciidoctor-stylesheet-factory](https://github.com/asciidoctor/asciidoctor-stylesheet-factory) project).\n\nThe theme source code is contained in two files: `sass/cuba.scss` and `sass/settings/_cuba.scss`. After making changes in these files, execute the `buildCubaTheme` Gradle task. As a result, a new `cuba.css` will be written to the `styles` directory.\n\nThe `buildCubaTheme` task requires the following Ruby gems:\n\n    gem install --no-rdoc --no-ri sass -v 3.4.22\n    gem install --no-rdoc --no-ri compass\n    gem install zurb-foundation\n    \nIf you get an error like \n\n    C:/Program Files/Ruby21-x64/lib/ruby/gems/2.1.0/gems/compass-core-1.0.3/lib/compass/core/sass_extensions/functions/urls.rb:5:in `has?': undefined method `has?' for Sass::Util:Module (NoMethodError)\n            from C:/Program Files/Ruby21-x64/lib/ruby/gems/2.1.0/gems/compass-core-1.0.3/lib/compass/core/sass_extensions/functions/urls.rb:9:in `included'\n            from C:/Program Files/Ruby21-x64/lib/ruby/gems/2.1.0/gems/sass-3.5.0.pre.rc.1/lib/sass/script/functions.rb:632:in `include'\n\nthen try to uninstall gem `sass-3.5.0.pre.rc.1` and install `3.4.22`. Perhaps you should also reinstall all the other gems. \n\n### Notes on PDF Generation\n\nThe PDF generation is based on the [Asciidoctor PDF](https://asciidoctor.org/docs/asciidoctor-pdf/).\n\nDue to the issue \u003chttps://github.com/asciidoctor/asciidoctor-pdf/issues/830\u003e images in table cells should have `pdfwidth=xxin` attribute.\n\n## Viewing Documentation Locally\n\nAfter installing Tomcat and deploying a document as described above, start the server:\n\n    ./deploy/tomcat/bin/startup.sh \n\nIf you build, for example, manual for version 7.1, it will be available at\n[http://localhost:6080/manual-7.1](http://localhost:6080/manual-7.1).  \n    \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcuba-platform%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcuba-platform%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcuba-platform%2Fdocumentation/lists"}