[ 
https://issues.apache.org/jira/browse/HDDS-4889?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Attila Doroszlai updated HDDS-4889:
-----------------------------------
    Description: 
The goal of this task is to add a separate check for building 
{{hadoop-hdds/docs}} with Hugo.

Benefits:

# separation of concerns: Currently docs are implicitly built in _integration_ 
checks.  If there is a syntax error in the docs, all of these fail due to the 
same cause.  (Used to be built in _findbugs_, _unit_, too, but these no longer 
have Hugo available.)
# better error reporting: The above checks do not collect compile errors in 
their summaries.  Thus one needs to dig into build logs to find any such 
problem.


  was:
The goal of this task is to add a separate check for building 
{{hadoop-hdds/docs}} with Hugo.

Benefits:

# separation of concerns: Currently docs are implicitly built in multiple 
checks (eg. _findbugs_, _unit_, _integration_).  If there is a syntax error in 
the docs, all of these fail due to the same cause.
# better error reporting: The above checks do not collect compile errors in 
their summaries.  Thus one needs to dig into build logs to find any such 
problem.



> Add simple CI check for docs
> ----------------------------
>
>                 Key: HDDS-4889
>                 URL: https://issues.apache.org/jira/browse/HDDS-4889
>             Project: Apache Ozone
>          Issue Type: Improvement
>          Components: build
>            Reporter: Attila Doroszlai
>            Assignee: Attila Doroszlai
>            Priority: Major
>              Labels: pull-request-available
>
> The goal of this task is to add a separate check for building 
> {{hadoop-hdds/docs}} with Hugo.
> Benefits:
> # separation of concerns: Currently docs are implicitly built in 
> _integration_ checks.  If there is a syntax error in the docs, all of these 
> fail due to the same cause.  (Used to be built in _findbugs_, _unit_, too, 
> but these no longer have Hugo available.)
> # better error reporting: The above checks do not collect compile errors in 
> their summaries.  Thus one needs to dig into build logs to find any such 
> problem.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to