Commit e13d5130 authored by Aurelien's avatar Aurelien
Browse files

Update .gitlab/issue_templates/new_job.md

parent e874e3e8
Loading
Loading
Loading
Loading
+12 −10
Original line number Diff line number Diff line
@@ -17,15 +17,21 @@
(Relevant screenshots or logs can be provided - please use code blocks (```) to format console output,
logs, and code as it's very hard to read otherwise.)

# Example to add a Doxygen job
# Possibles stages or label to this jobs

## Objectives
(Identify Stages and Labels available by checking [the documenation](https://hub.go2scale.io/jobs/))

# ❓ Help - (You can erase that part below before submitting) 🧽

## Example to add a Doxygen job

### Objectives

Provide a job to build automatically documenation using [the Doxygen syntax](https://www.doxygen.nl/index.html) for 10 langages.

Generate the documenation in [more than 10 output formats](https://www.doxygen.nl/manual/output.html) such as HTML, $\mbox{\LaTeX}$, XML,...
Generate the documenation in [more than 10 output formats](https://www.doxygen.nl/manual/output.html) such as HTML, LaTeX, XML,...

### List of supported langage
#### List of supported langage
- C++ 
- C
- Objective-C
@@ -37,7 +43,7 @@ Generate the documenation in [more than 10 output formats](https://www.doxygen.n
- Fortran
- VHDL

## Use case
### Use case
The job will browse your source code and generate the documenation in the output format choosen.

Your source code must be completed with the Doxygen syntax before running this jobs.
@@ -47,7 +53,7 @@ Your source code must be completed with the Doxygen syntax before running this j
- So that the documentation will be up-to-date with no effort


## Artifacts
### Artifacts

(List the artifacts expected by this job)

@@ -55,7 +61,3 @@ Your source code must be completed with the Doxygen syntax before running this j
Generate a html folder with the documentation generated
- When failed
Generate nothing, the report of the execution will be available in the runner output console


### Screenshots of the documentation