diff --git a/.gitmodules b/.gitmodules index e68cff8..d6930df 100644 --- a/.gitmodules +++ b/.gitmodules @@ -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 diff --git a/README.md b/README.md index 291162a..be17c4a 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/general/general-compliance.asciidoc b/general/general-compliance.asciidoc deleted file mode 100644 index 356a8a3..0000000 --- a/general/general-compliance.asciidoc +++ /dev/null @@ -1,3 +0,0 @@ -= OSS Compliance - -include::Cookbook-OSS-Compliance[leveloffset=2] diff --git a/general/getting-started-download-and-setup.asciidoc b/general/getting-started-download-and-setup.asciidoc deleted file mode 100644 index 6d298a2..0000000 --- a/general/getting-started-download-and-setup.asciidoc +++ /dev/null @@ -1,65 +0,0 @@ -:toc: macro -toc::[] - -:doctype: book -:reproducible: -:source-highlighter: rouge -:listing-caption: Listing - -= Download and Setup - -In this section, you will learn how to setup the devonfw environment and start working on first project based on devonfw. - -The devonfw environment contains all software and tools necessary to develop the applications with devonfw. - -== Prerequisites - -In order to setup the environment, following are the prerequisites: - -* Internet connection (including details of your proxy configuration, if necessary) -* >1GB of free disk space to install customized environment -* Command line tool devonfw IDE is already installed - -== Download -IMPORTANT: Please refer to the link:setup[devonfw IDE] documentation for the **current installation process**. - -Older devonfw distributions can be obtained from the http://de-mucevolve02/files/devonfw/[FTP releases library] and are packaged in a _zip_ file that includes all the needed tools, software and configurations. Browse to the corresponding version folder in order to get the latest version. - -=== Setup the workspace for older versions - -1. Unzip the devonfw distribution into a directory of your choice. *The path to the devonfw distribution directory should contain no spaces*, to prevent problems with some of the tools. - -1. Run the batch file "create-or-update-workspace.bat". - -image::images/download-install/devon_guide_environment_setup_1_create_workspace.png[, width="350", devon_guide_environment_setup_1_create_workspace, link="images/download-install/devon_guide_environment_setup_1_create_workspace.png"] - -This will configure the included tools like Eclipse with the default settings of the devonfw distribution. - -The result should be as seen below - -image::images/download-install/devon_guide_environment_setup_2_create_workspace.png[, width="450", link="images/download-install/devon_guide_environment_setup_2_create_workspace.png"] -[start=3] - -*The working devonfw environment is ready!* - -*Note* : If you use a proxy to connect to the Internet, you have to manually configure it in Maven, Sencha Cmd and Eclipse. Next section explains about it. - -=== Setup the workspace for older versions (Linux) - -* Unzip the devonfw distribution into a directory of your choice. *The path to the devonfw distribution directory should contain no spaces*, to prevent problems with some of the tools. - -* Run the script: . env.sh - -image::images/download-install/run_env_sh.png[, width="550", run_env_sh, link="images/download-install/run_env_sh.png"] - -* Run the script: . create-or-update-workspace - -image::images/download-install/create_update_ws.png[, width="550", create_update_ws, link="images/download-install/create_update_ws.png"] - -These both . env.sh and . create-or-update-workspace will set PATH for all the software included with devon distribution like: eclipse, maven, java etc. Also this will generate some file like eclipse_main used to invoke eclipse. - -* For vscode setup we have to execute create-or-update-workspace-vs - -* There are a also scripts initialize.sh and uninstallUI.sh. -** initialize.sh: installs angular, node, python, ant, and subversion -** uninstallUI.sh: is used to uninstall the above software diff --git a/general/getting-started-the-devon-ide.asciidoc b/general/getting-started-the-devon-ide.asciidoc deleted file mode 100644 index 21f3a45..0000000 --- a/general/getting-started-the-devon-ide.asciidoc +++ /dev/null @@ -1,206 +0,0 @@ -:toc: macro -toc::[] - -:doctype: book -:reproducible: -:source-highlighter: rouge -:listing-caption: Listing - -= The Devon IDE - -== Introduction - -The Devon IDE is the general name for two distinct versions of a customized Eclipse which comes in a Open Source variant, called devon-ide, and a more extended version included in the "Devon Dist" which is only available for Capgemini engagements. - -=== Features and advantages - -devonfw comes with a fully featured IDE in order to simplify the installation, configuration and maintenance of this instrumental part of the development environment. As it is being included in the distribution, the IDE is ready to be used and some specific configuration of certain plugins only takes a few minutes. - -image::images/devon-ide/integrated-ide.png["Integrated IDE",width="450", link="images/devon-ide/integrated-ide.png"] - -As with the remainder of the distribution, the advantage of this approach is that you can have as many instances of the -ide "installed" on your machine for different projects with different tools, tool versions and configurations. No physical installation and no tweaking of your operating system required. "Installations" of the Devon distribution do not interfere with each other nor with other installed software. - -=== Multiple Workspaces - -There is inbuilt support for working with different workspaces on different branches. Create and update new workspaces with a few clicks. You can see the workspace name in the title-bar of your IDE so you do not get confused and work on the right branch. - -== CobiGen - -In the Devon distribution we have a code generator to create CRUD code, called *CobiGen*. This is a generic incremental generator for end to end code generation tasks, mostly used in Java projects. Due to a template-based approach, CobiGen generates any set of text-based documents and document fragments. - -image::images/devon-ide/cobigen.png[,width="450",link="images/devon-ide/cobigen.png"] - -CobiGen is distributed in the Devon distribution as an Eclipse plugin, and is available to all Devon developers for Capgemini engagements. Due to the importance of this component and the scope of its functionality, it is fully described <>. - -== IDE Plugins: - -Since an application's code can greatly vary, and every program can be written in lots of ways without being semantically different, IDE comes with pre-installed and pre-configured plugins that use some kind of a probabilistic approach, usually based on pattern matching, to determine which pieces of code should be reviewed. These hints are a real time-saver, helping you to review incoming changes and prevent bugs from propagating into the released artifacts. Apart from CobiGen mentioned in the previous paragraph, the IDE provides CheckStyle, SonarQube, FindBugs and SOAP-UI. Details of each can be found in subsequent sections. - -=== CheckStyle - -==== What is CheckStyle - -http://eclipse-cs.sourceforge.net/[CheckStyle] is a Open Source development tool to help you ensure that your Java code adheres to a set of coding standards. CheckStyle does this by inspecting your Java source code and pointing out items that deviate from a defined set of coding rules. - -With the CheckStyle IDE Plugin, your code is constantly inspected for coding standard deviations. Within the Eclipse workbench, you are immediately notified with the problems via the Eclipse Problems View and source code annotations similar to compiler errors or warnings. -This ensures an extremely short feedback loop right at the developers fingertips. - -==== Why use CheckStyle - -If your development team consists of more than one person, then obviously a common ground for coding standards (formatting rules, line lengths etc.) must be agreed upon - even if it is just for practical reasons to avoid superficial, format related merge conflicts. -CheckStyle Plugin helps you define and easily apply those common rules. - -The plugin uses a project builder to check your project files with CheckStyle. Assuming the IDE Auto-Build feature is enabled, each modification of a project file will immediately get checked by CheckStyle on file save - giving you immediate feedback about the changes you made. To use a simple analogy, the CheckStyle Plug-in works very much like a compiler but instead of producing .class files, it produces warnings where the code violates CheckStyle rules. The discovered deviations are accessible in the Eclipse Problems View, as code editor annotations and via additional CheckStyle violations views. - -==== Installation of CheckStyle - -After IDE installation, IDE provides default CheckStyle configuration file which has certain check rules specified . -The set of rules used to check the code is highly configurable. A CheckStyle configuration specifies which check rules are validated against the code and with which severity violations will be reported. Once defined a CheckStyle configuration can be used across multiple projects. The IDE comes with several pre-defined CheckStyle configurations. -You can create custom configurations using the plugin's CheckStyle configuration editor or even use an existing CheckStyle configuration file from an external location. - -You can see violations in your workspace as shown in below figure. - -image::images/devon-ide/checkstyle.png["checkstyle", width = "450" , link="images/devon-ide/checkstyle.png"] - -==== Usage - -So, once projects are created, follow steps mentioned below, to activate CheckStyle: - -[start=1] -. Open the properties of the project you want to get checked. - -image::images/devon-ide/checkstyle2.png["checkstyle2", width = "450" , link="images/devon-ide/checkstyle2.png"] - -[start=2] -. Select the CheckStyle section within the properties dialog. - -image::images/devon-ide/checkstyle3.png["checkstyle3", width = "450" , link="images/devon-ide/checkstyle3.png"] - - -[start=3] -. Activate CheckStyle for your project by selecting the CheckStyle active for this project check box and press OK - - -image::images/devon-ide/checkstyle4.png["checkstyle4", width = "450" , link="images/devon-ide/checkstyle4.png"] - - - -Now CheckStyle should begin checking your code. This may take a while depending on how many source files your project contains. -The CheckStyle Plug-in uses background jobs to do its work - so while CheckStyle audits your source files you should be able to continue your work. -After CheckStyle has finished checking your code please look into your Eclipse Problems View. -There should be some warnings from CheckStyle. This warnings point to the code locations where your code violates the pre-configured Checks configuration. - - -image::images/devon-ide/checkstyle5.png["checkstyle5", width = "450" , link="images/devon-ide/checkstyle5.png"] - - - -You can navigate to the problems in your code by double-clicking the problem in you problems view. -On the left hand side of the editor an icon is shown for each line that contains a CheckStyle violation. Hovering with your mouse above this icon will show you the problem message. -Also note the editor annotations - they are there to make it even easier to see where the problems are. - - -=== FindBugs - -==== What is FindBugs - -http://findbugs.sourceforge.net/[FindBugs]is an open source project for a static analysis of the Java bytecode to identify potential software bugs. FindBugs provides early feedback about potential errors in the code. - -==== Why use FindBugs - -It scans your code for bugs, breaking down the list of bugs in your code into a ranked list on a 20-point scale. The lower the number, the more hardcore the bug.This helps the developer to access these problems early in the development phase. - -==== Installation and Usage of FindBugs - -IDE comes preinstalled with FindBugs plugin. - -You can configure that FindBugs should run automatically for a selected project. For this right-click on a project and select Properties from the popup menu. via the project properties. Select FindBugs → Run automatically as shown below. - -image::images/devon-ide/FindBugs1.png["configure FindBugs",width="450",link="images/devon-ide/FindBugs1.png"] - - -To run the error analysis of FindBugs on a project, right-click on it and select the Find Bugs... → Find Bugs menu entry. - -image::images/devon-ide/FindBugs2.png["error analysis",width="450",link="images/devon-ide/FindBugs2.png"] - -Plugin provides specialized views to see the reported error messages. Select Window → Show View → Other... to access the views. -The FindBugs error messages are also displayed in the Problems view or as decorators in the Package Explorer view. - -image::images/devon-ide/FindBugs3.png["ShowView bug Explorer",width="450",link="images/devon-ide/FindBugs3.png"] - -image::images/devon-ide/FindBugs4.png["bug Explorer",width="450",link="images/devon-ide/FindBugs4.png"] - -=== SonarLint - -==== what is SonarLint - -http://www.sonarlint.org/[SonarLint] is an open platform to manage code quality. -It provides on-the-fly feedback to developers on new bugs and quality issues injected into their code.. - -==== Why use SonarLint - -It covers seven aspects of code quality like junits, coding rules,comments,complexity,duplications, architecture and design and potential bugs. -SonarLint has got a very efficient way of navigating, a balance between high-level view, dashboard and defect hunting tools. This enables to quickly uncover projects and / or components that are in analysis to establish action plans. - -==== Installation and usage of SonarLint - -IDE comes preinstalled with SonarLint. -To configure it , please follow below steps: - -First of all, you need to start sonar service. For that, go to software folder which is extracted from Devon-dist zip, choose sonarqube->bin->-->and execute startSonar bat file. - -If your project is not already under analysis, you'll need to declare it through the SonarQube web interface as described http://docs.sonarqube.org/display/SONAR/Project+Existence[here]. -Once your project exists in SonarQube, you're ready to get started with SonarQube in Eclipse. - -SonarLint in Eclipse is pre-configured to access a local SonarQube server listening on http://localhost:9000/. -You can edit this server, delete it or add new ones.By default, user and password is "admin".If sonar service is started properly, test connection will give you successful result. - -image::images/devon-ide/Sonar_add_server.png["Sonar_add_server", width = "450" , link="images/devon-ide/Sonar_add_server.png"] - - -For getting a project analysed on sonar, refer this http://docs.sonarqube.org/display/SONAR/Analyzing+Source+Code [link]. - -Linking a project to one analysed on sonar server. - -image::images/devon-ide/associate-sonarqube.png["associate-sonarqube", width = "450" , link="images/devon-ide/associate-sonarqube.png"] - - - -In the SonarQube project text field, start typing the name of the project and select it in the list box: - -image::images/devon-ide/link-with-project.png["link-with-project", width = "450" , link="images/devon-ide/link-with-project.png"] - - -Click on Finish. Your project is now associated to one analyzed on your SonarQube server. - -*Changing Binding* - -At any time, it is possible to change the project association. - -To do so, right-click on the project in the Project Explorer, and then SonarQube > Change Project Association. - -image::images/devon-ide/change-link-with-project.png["change-link-with-project", width = "450" , link="images/devon-ide/change-link-with-project.png"] - - -*Unbinding a Project* - -To do so, right-click on the project in the Project Explorer, and then SonarQube > Remove SonarQube Nature. - -image::images/devon-ide/unlink-with-project.png["unlink-with-project", width = "450" , link="images/devon-ide/unlink-with-project.png"] - - -*Advanced Configuration* - -Additional settings (such as markers for new issues) are available through Window > Preferences > SonarLint - -image::images/devon-ide/eclipse-settings.png["eclipse-settings", width = "450" , link="images/devon-ide/eclipse-settings.png"] - - - -To look for sonarqube analysed issue, go to Window->Show View-> Others->SonarLint->SonarLint Issues. -Now you can see issues in soanrqube issues tab as shown - -image::images/devon-ide/sonarQube-issues-view.png["sonarQube-issues-view", width = "450" , link="images/devon-ide/sonarQube-issues-view.png"] - - -Or you can go to link http://localhost:9000 and login with admin as id and admin as password and goto Dashboard.you can see all the statistics of analysis of the configured projects on sonar server. \ No newline at end of file diff --git a/general/getting-started-what-is-devonfw.asciidoc b/general/getting-started-what-is-devonfw.asciidoc deleted file mode 100644 index fd0bf1f..0000000 --- a/general/getting-started-what-is-devonfw.asciidoc +++ /dev/null @@ -1,86 +0,0 @@ -:toc: macro -toc::[] - -:doctype: book -:reproducible: -:source-highlighter: rouge -:listing-caption: Listing - -= devonfw Introduction - -image::images/devonfw-small.png[,align="center",width="200",devonfw, link="images/devonfw-small.png"] - -Welcome to *devonfw*, the devonfw platform. This is a product of the CSD industrialization effort to bring a standardized platform for custom software development within Capgemini APPS2. This platform is aimed at engagements where clients do not force the use of a determined technology so we can offer a better alternative coming from our experience as a group. - -http://www.devonfw.com[devonfw] is a development platform aiming for standardization of processes and productivity boost, that provides an architecture blueprint for Java/JavaScript applications, alongside a set of tools to provide a fully functional _out-of-the-box_ development environment. - -Please note that the _devonfw_ name is a registered trademark of image:images/Capgemini_Logo_Small.png[,width="95", Capgemini, link="https://www.capgemini.com/"]. - -== Building Blocks of the Platform - -image::images/introduction/devonfwcatalog.png[,width="650",devonfw Building blocks,link="images/introduction/devonfwcatalog.png"] - -devonfw uses a state-of-the-art open source core reference architecture for the server (today considered as commodity in the IT-industry) and on top of it an ever increasing number of high-value assets that are developed by Capgemini. - -== devonfw Technology Stack - -devonfw is fully Open Source and consists of the following technology stacks. - -=== Back-end solutions - -- https://github.com/devonfw/devon4j[_devon4j_]: server implemented with Java. The devonfw platform provides an implementation for Java based on https://spring.io/[Spring] and https://projects.spring.io/spring-boot/[Spring Boot]. - -- https://github.com/devonfw/devon4net[_devon4net_]: server implementation based on https://dotnet.microsoft.com/[.NET]. - -- https://github.com/devonfw/devon4node[_devon4node_]: server implementation based on https://nestjs.com/[NestJS]. - -=== Front-end solutions - -For client applications, _devonfw_ includes two possible solutions based on _TypeScript, JavaScript, C# and .NET_: - -- https://github.com/devonfw/devon4ng[devon4ng]: Frontend implementation based on https://angular.io/[Angular] and hybrid mobile implementation based on https://ionicframework.com/[Ionic]. - -- https://github.com/devonfw/devon4x[devon4X]: Mobile implementation based on https://docs.microsoft.com/xamarin/[Xamarin]. - -Check out the links for more details. - -== Custom Tools - -=== devonfw-ide - -The `devonfw-ide` is the new and fantastic tool to automatically download, install, setup and update the IDE (integrated development environment) of your _devonfw_ projects. - -==== IDEs - -It supports the following IDEs: - -* link:eclipse[Eclipse] -* link:vscode[Visual Studio Code] -* link:intellij[IntelliJ] - -==== Platforms - -It supports the following platforms: - -* link:java[java] (see also https://github.com/devonfw/devon4j/wiki[devon4j]) -* link:cs[C#] (see https://devon4net.github.io/[devon4net]) -* link:node[node].js and link:ng[angular] (see https://github.com/devonfw/devon4ng/wiki[devon4ng]) - -==== Build-Systems - -It supports the following build-systems: - -* link:mvn[mvn] (maven) -* link:npm[npm] -* link:gradle[gradle] - -However, also other IDEs, platforms, or tools can be easily integrated as link:cli#commandlet[commandlet]. - -=== CobiGen - -_CobiGen_ is a code generator included in the context of _devonfw_ that allows users to generate all the structure and code of the components, helping to save a lot of time wasted in repetitive tasks. - -image::images/cobigen.png[,width="550", link="images/devon/cobigen.png"] - -Following the same philosophy CobiGen now bundles a new command line interface (CLI) that enables the generation of code using few commands. This feature allows us to decouple CobiGen from Eclipse and be able to use it alongside VS Code or IntelliJ. - diff --git a/general/getting-started-why-should-i-use-devonfw.asciidoc b/general/getting-started-why-should-i-use-devonfw.asciidoc deleted file mode 100644 index 29e3144..0000000 --- a/general/getting-started-why-should-i-use-devonfw.asciidoc +++ /dev/null @@ -1,88 +0,0 @@ -:toc: macro -toc::[] - -:doctype: book -:reproducible: -:source-highlighter: rouge -:listing-caption: Listing - -= Why should I use devonfw? - -Devonfw aims at providing a framework which is oriented at development of web applications based on the Java EE programming model using the Spring framework project as the default implementation. - -== Objectives - -=== Standardization - -It means that to stop reinventing the Wheel in thousands of projects, hundreds of centers, dozens of countries. This also includes rationalize, harmonize and standardize all development assets all over the group and industrialize the software development process - - -=== Industrialization of Innovative technologies & “Digital” - -devonfw needs to standardize & industrialize. But not just large volume, “traditional” custom software development. devonfw needs to offer a standardized platform which contains a range of state of the art methodologies and technology options. devonfw needs to support agile development by small teams utilizing the latest technologies for Mobile, IoT and the Cloud - -=== Deliver & Improve Business Value - -image::images/introduction/devon_quality_agility.png[,width="250", link="images/introduction/devon_quality_agility.png"] - -=== Efficiency - - - Up to 20% reduction in time to market with faster delivery due to automation and reuse. - - - Up to 25% less implementation efforts due to code generation and reuse. - - - Flat pyramid and rightshore, ready for juniors. - -=== Quality - - - State of the Art architecture and design. - - - Lower cost on maintenance and warranty. - - - Technical debt reduction by reuse. - - - Risk reduction due to assets continuous improvement. - - - Standardized automated quality checks. - - -=== Agility - - - Focus on business functionality not on technical. - - - Shorter release cycles. - - - DevOps by design - Infrastructure as Code. - - - Continuous Delivery Pipeline. - - - On and Off-premise flexibility. - - - PoCs and Prototypes in days not months. - - -== Features - -=== Everything in a single zip - -The devonfw distributions is packaged in a _zip_ file that includes all the http://devonfw.github.io/index.html[Custom Tools], http://devonfw.github.io/index.html[Software] and configurations. - -Having all the dependencies self-contained in the distribution's _zip_ file, users don't need to install or configure anything. Just extracting the _zip_ content is enough to have a fully functional _devonfw_. - -=== devonfw, the package - -devonfw package provides: - - - Implementation blueprints for a modern cloud-ready server and a choice on JS-Client technologies (either open source Angular or a very rich and impressive solution based on commercial Sencha UI). - - - Quality documentation and step-by-step quick start guides. - - - Highly integrated and packaged development environment based around Eclipse and Jenkins. You will be ready to start implementing your first customer-specific use case in 2h time. - - - Iterative eclipse-based code-generator that understands "Java" and works on higher architectural concepts than Java-classes. - - - Example application as a reference implementation. - - - Support through large community + industrialization services (Standard Platform as a service) available in the iProd service catalog. - -To read in details about devonfw features read <> \ No newline at end of file diff --git a/general/master-contributing.asciidoc b/general/master-contributing.asciidoc new file mode 100644 index 0000000..6a27438 --- /dev/null +++ b/general/master-contributing.asciidoc @@ -0,0 +1,7 @@ += Contributing + +include::../.github/CONTRIBUTING[leveloffset=1] + +include::../.github/CODE_OF_CONDUCT[leveloffset=1] + +include::oss-compliance[leveloffset=1] \ No newline at end of file diff --git a/general/master-general-start.asciidoc b/general/master-general-start.asciidoc deleted file mode 100644 index b1ff1ed..0000000 --- a/general/master-general-start.asciidoc +++ /dev/null @@ -1,10 +0,0 @@ -= Getting Started - -include::getting-started-what-is-devonfw.asciidoc[leveloffset=1] - -include::getting-started-why-should-i-use-devonfw.asciidoc[leveloffset=1] - -include::getting-started-download-and-setup.asciidoc[leveloffset=1] - -include::getting-started-the-devon-ide.asciidoc[leveloffset=1] - diff --git a/general/general-release-notes.asciidoc b/general/master-release-notes.asciidoc similarity index 100% rename from general/general-release-notes.asciidoc rename to general/master-release-notes.asciidoc diff --git a/general/Cookbook-OSS-Compliance.asciidoc b/general/oss-compliance.asciidoc similarity index 99% rename from general/Cookbook-OSS-Compliance.asciidoc rename to general/oss-compliance.asciidoc index 4f8cc98..936ed9e 100644 --- a/general/Cookbook-OSS-Compliance.asciidoc +++ b/general/oss-compliance.asciidoc @@ -3,7 +3,7 @@ toc::[] :idprefix: :idseparator: - -= Cookbook OSS Compliance += OSS Compliance This chapter helps you to gain transparency on OSS usage and reach OSS compliance in your project. diff --git a/getting-started.wiki b/getting-started.wiki new file mode 160000 index 0000000..1e579ef --- /dev/null +++ b/getting-started.wiki @@ -0,0 +1 @@ +Subproject commit 1e579ef2a152d95c3b759d66de3126b20df53b0a diff --git a/master.asciidoc b/master.asciidoc index 2e7bbcb..a10dd14 100644 --- a/master.asciidoc +++ b/master.asciidoc @@ -11,7 +11,7 @@ Updated at {localdatetime} :chapter-label: :partnums: -include::general/master-general-start[leveloffset=0] +include::getting-started.wiki/master-getting-started[leveloffset=0] include::ide.wiki/master-ide[leveloffset=0] @@ -37,10 +37,6 @@ include::mrchecker.wiki/master-mrchecker[leveloffset=0] include::my-thai-star.wiki/master-my-thai-star[leveloffset=0] -include::.github/CONTRIBUTING[leveloffset=0] +include::general/master-contributing[leveloffset=0] -include::.github/CODE_OF_CONDUCT[leveloffset=1] - -include::general/general-compliance[leveloffset=1] - -include::general/general-release-notes[leveloffset=0] +include::general/master-release-notes[leveloffset=0]