Rewrite Developer Quickstart Guide

[Jeeppler]

Problem

The current developer quickstart guide uses the integration test mode to show how to use SecHub. This is a problem, because the integration test mode was created for integration tests and is optimized for that particular use case.

With #1646 a new beginner guide/tutorial was introduced, which explains to external users how to use SecHub + GoSec-PDS to do a real scan. As a result, the quickstart guide with the integration test was renamed to developer quickstart guide.

Wanted

Rewrite the developer quickstart guide to include the basic steps to get started with developing a new feature for SecHub. The guide should focus on Java and Go developers.

The developer quickstart guide should include the steps to:

• clone the project
• change a small feature with major consequences

Java:

• setup the development environment (Eclipse IDE)
  • run sechub and pds
  • create run configurations

Go:

• setup the development environment (VSCodium)
  • run the client

[N-Saipraveen]

can I work on this

[Jeeppler]

@N-Saipraveen you are more than welcome to take on this issue. Just keep in mind, this is not the most beginner friendly issue.

I will assign you to this issue, if you change your mind about doing it or prefer another one, than let me know.

[N-Saipraveen]

sure i will try my best

[de-jcup]

@N-Saipraveen : Is there any progress? If you do not work on this any more please give us feedback.

An important remark from my side: Inside sechub-techdoc.adoc we have

include::documents/techdoc/01_development.adoc[]

The current quickstart guide does unfortunately NOT use such parts at all. But there are important information available. E.g. coding conventions, git setup etc. etc.

We try to have no duplicated information and a single resource to maintain - so if you think the information is "too much" inside the included parts, please separate them into smaller adoc files and include the necessary ones inside the quickstart guide - thank you.