https://github.com/devonfw/devonfw-guide
devonfw consolidated documentation
https://github.com/devonfw/devonfw-guide
asciidoc devonfw docgen
Last synced: 4 months ago
JSON representation
devonfw consolidated documentation
- Host: GitHub
- URL: https://github.com/devonfw/devonfw-guide
- Owner: devonfw
- License: other
- Created: 2019-04-30T07:07:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-04T16:02:23.000Z (about 1 year ago)
- Last Synced: 2025-03-04T17:20:26.021Z (about 1 year ago)
- Topics: asciidoc, devonfw, docgen
- Size: 6.33 GB
- Stars: 12
- Watchers: 20
- Forks: 25
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# devonfw guide
---
**IMPORTANT**
Download the **continuously updated devonfw guide** from [here](https://github.com/devonfw/devonfw-guide/raw/master/devonfw_guide.pdf).
---
This repository contains a collection of guides and documents from different _devonfw_ modules:
- **getting started**: Standalone introduction guide.
- **ide**: devonfw IDE.
- **devon4j**: Module for Java
- **devon4ng**: Module for Angular
- **devon4net**: Module for .NET
- **devon4node**: Module from Node.js
- **database**: Information on selecting a suitable database.
- **devonfw shop floor**: Set of documentation, tools and methodologies used to configure provisioning, development and uat environments used in devonfw projects.
- **cicdgen**: Tool to generate CI/CD configurations for devonfw projects.
- **production line**: Templates and info on setting up a Jenkins PL.
- **CobiGen**: Code-based incremental generator.
- **MrChecker**: E2E testing framework.
- **MyThaiStar**: devonfw reference application.
- **contributing**: Contributing and OSS compliance guidelines, community code of conduct.
- **release notes**: Chagelogs and feature-lists of devonfw releases.
## How this guide is organized
Each submodule contains a master file `name-of-the-wiki.wiki/master-name-of-the-wiki.asciidoc` which includes all the other files in the submodule. All `master-*.asciidoc` files are joined in `devonfw-guide/master.asciidoc`. This way, all documents are linked and can be used to generate a complete file.
## How to generate a PDF
Please find the documentation how to generate a PDF for your project/wiki in the [docgen repository](https://github.com/devonfw/docgen/wiki#usage).
**IMPORTANT**
If your directory contains a large amount of files, Maven might throw an `OutOfMemoryError`. For information on how to fix this issue please refer to: [Maven OutOfMemoryError](https://cwiki.apache.org/confluence/display/MAVEN/OutOfMemoryError).