adoroszlai opened a new pull request #2156:
URL: https://github.com/apache/ozone/pull/2156


   ## What changes were proposed in this pull request?
   
   Currently docs are implicitly built in _integration_ checks.  (They used to 
be built in few other checks, too, but those no longer have Hugo available.)  
If there is a syntax error in the docs, all of these fail due to the same 
cause.  Also, one needs to dig into build logs to find any problem, because 
Hugo errors are not collected.
   
   This PR adds a separate check for building `hadoop-hdds/docs` with Hugo, 
collecting summary of Hugo-specific failures in the regular way.
   
   https://issues.apache.org/jira/browse/HDDS-4889
   
   ## How was this patch tested?
   
   ```
   > Run hadoop-ozone/dev-support/checks/docs.sh
   ...
   Installed hugo in /home/runner/work/hadoop-ozone/hadoop-ozone/.dev-tools/hugo
   ~/work/hadoop-ozone/hadoop-ozone
   Start building sites … 
   
                      | EN | ZH  
   -------------------+----+-----
     Pages            | 81 | 49  
     Paginator pages  |  0 |  0  
     Non-page files   | 22 | 22  
     Static files     | 26 | 26  
     Processed images |  0 |  0  
     Aliases          |  1 |  0  
     Sitemaps         |  2 |  1  
     Cleaned          |  0 |  0  
   
   Total in 188 ms
   ```
   
   https://github.com/adoroszlai/hadoop-ozone/runs/2344467280#step:4:1
   
   Introduced reference to non-existing page locally, verified output:
   
   ```
   $ hadoop-ozone/dev-support/checks/docs.sh
   ...
   Error: Error building site: logged 1 error(s)
   
   $ cat target/docs/summary.txt
   ERROR 2021/04/14 17:30:42 [en] REF_NOT_FOUND: Ref "asdfJavaApi.md": 
"hadoop-hdds/docs/content/_index.md:33:138": page not found
   
   $ cat target/docs/failures
   1
   ```


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
[email protected]



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

Reply via email to