Create an issue through webforms

Issue creation is the first step in the issue life cycle and is a vital part of the errata service as it revolves around community contributions. However, creating an issue must abide to a set of rules described below.

It is also important to highlight unauthenticated users can propose errata entries, that will be persisted in the database and pending moderation. Proposing issues is described in a dedicated page.

Creating an issue as an authenticated user:

Log into the errata service
From the errata home page click on the create button in the right side of the top menu
Fill the form following the (strict) set of requirements
- The project is mandatory and value controlled
- A title between 16 and 255 characters is mandatory Warning: you will not be able to change the project and title again.
- A description between 16 and 1023 characters is mandatory. A precise and conise issue description that must make sense for end-users (not just "wrong data") is highly recommended.
- The severity is mandatory and value-controlled, the field is a drop menu choice in any case. Note: The possible values for severity are: - low: issue concerning file management (e.g. addition, removal, period extension etc..) - medium: issue concerning metadata (NetCDF attributes) without undermining the values of the involved variable. - high: issue concerns single point variable or axis values - critical: issue concerns a varaible or axis values undermining the analysis. The use of this data is therefore strongly discouraged.
- A list of links and materials can be provided, the URLs will be checked to be valid (on validation)
- A dataset list is mandatory and will be used to extract the different identifiers of the affected datasets (experiment, variables etc) Note: A dataset identifier is a sequence of dot-separated facets that follows the Data Reference Syntax of the corresponding project. The dataset identifiers has to append the dataset version number. If one of the dataset ID is malformed or if the dataset list is empty, the form will raise an error.

Click on "Save" button on the upper menu
The request will be processed, fields need to be validated against the set of rules and controlled vocabulary (using pyessv).
If everything checks out, a success message is displayed, user is then redirected to the issue landing page (the URL can be shared and broadcasted)

If an anomaly is detected, an error message is displayed with the cause of the error.

Few notes:

Errata service will automatically assign a newly created issue with the status "New"
Errata service will generate a unique identifier on issue creation and assigns to the issue throughout its lifecycle. The identifier can be used to retrieve the issue through the CLI for example.
The issue creation date and author details will be automatically assigned to the issue by the service.

PreviousLog in to the errata service NextPropose an issue through webforms

Last updated 7 months ago

Creating an issue as an authenticated user:

Log into the errata service

From the errata home page click on the create button in the right side of the top menu

Fill the form following the (strict) set of requirements

The project is mandatory and value controlled
A title between 16 and 255 characters is mandatory Warning: you will not be able to change the project and title again.
A description between 16 and 1023 characters is mandatory. A precise and conise issue description that must make sense for end-users (not just "wrong data") is highly recommended.
The severity is mandatory and value-controlled, the field is a drop menu choice in any case. Note: The possible values for severity are: - low: issue concerning file management (e.g. addition, removal, period extension etc..) - medium: issue concerning metadata (NetCDF attributes) without undermining the values of the involved variable. - high: issue concerns single point variable or axis values - critical: issue concerns a varaible or axis values undermining the analysis. The use of this data is therefore strongly discouraged.
A list of links and materials can be provided, the URLs will be checked to be valid (on validation)
A dataset list is mandatory and will be used to extract the different identifiers of the affected datasets (experiment, variables etc) Note: A dataset identifier is a sequence of dot-separated facets that follows the Data Reference Syntax of the corresponding project. The dataset identifiers has to append the dataset version number. If one of the dataset ID is malformed or if the dataset list is empty, the form will raise an error.

Click on "Save" button on the upper menu

The request will be processed, fields need to be validated against the set of rules and controlled vocabulary (using pyessv).

If everything checks out, a success message is displayed, user is then redirected to the issue landing page (the URL can be shared and broadcasted)

If an anomaly is detected, an error message is displayed with the cause of the error.

Few notes:

Errata service will automatically assign a newly created issue with the status "New"

Errata service will generate a unique identifier on issue creation and assigns to the issue throughout its lifecycle. The identifier can be used to retrieve the issue through the CLI for example.

The issue creation date and author details will be automatically assigned to the issue by the service.