Skip to content

Commit

Permalink
Merge pull request #64 from phschimm/getting_started_rework
Browse files Browse the repository at this point in the history
Restructure of the Getting Started section
  • Loading branch information
sjimenez77 authored Jan 29, 2020
2 parents 85c68fe + cecac7b commit 8405484
Show file tree
Hide file tree
Showing 13 changed files with 30 additions and 478 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,6 @@
[submodule "cobigen.wiki"]
path = cobigen.wiki
url = https://github.com/devonfw/cobigen.wiki.git
[submodule "getting-started.wiki"]
path = getting-started.wiki
url = https://github.com/devonfw/getting-started.wiki.git
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,32 @@ Download the **continuously updated devonfw guide** from [here](https://github.c

---

This repository contains a collection of guides and documents from the different devonfw's modules, such as:
This repository contains a collection of guides and documents from different _devonfw_ modules:

- **getting started**: Standalone introduction guide.
- **ide**: devonfw IDE.
- **cicdgen**: Tool to generate CI/CD configurations for devonfw projects.
- **devon4j**: Module for Java
- **devon4net**: Module for .net
- **devon4ng**: Module for Angular
- **devon4node**: Module from node.js
- **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.
- **MrChecker**: E2E testing framework.
- **My Thai Star**: devonfw reference application.
- **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 is this guide organized
## 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 unique file.
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 [devonfw-docgen repository](https://github.com/devonfw/docgen).
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 huge amounts of files, maven can throw a OutOfMemoryError. More info at [Maven OutOfMemoryError](https://cwiki.apache.org/confluence/display/MAVEN/OutOfMemoryError)

---
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).
3 changes: 0 additions & 3 deletions general/general-compliance.asciidoc

This file was deleted.

65 changes: 0 additions & 65 deletions general/getting-started-download-and-setup.asciidoc

This file was deleted.

206 changes: 0 additions & 206 deletions general/getting-started-the-devon-ide.asciidoc

This file was deleted.

Loading

0 comments on commit 8405484

Please sign in to comment.