[GitHub] [couchdb] jaydoane commented on a diff in pull request #4164: Integrate docs into the main repo

[GitBox <gi...@apache.org>]

jaydoane commented on code in PR #4164:
URL: https://github.com/apache/couchdb/pull/4164#discussion_r965330220


##########
src/docs/README.md:
##########
@@ -0,0 +1,31 @@
+# CouchDB Documentation
+
+This directory contains the Sphinx source for Apache CouchDB's documentation.
+You can view the latest rendered build of this content at:
+
+    http://docs.couchdb.org/en/latest
+
+# Building this repo

Review Comment:
   Maybe just "Building the docs" or similar now that it's not a separate repo?



##########
build-aux/Jenkinsfile.pr:
##########
@@ -61,7 +64,68 @@ pipeline {
 
   stages {
 
+    stage('Docs Check') {
+      // Run docs `make check` stage if any docs changed
+      when { expression { return sh(returnStatus: true, script: docs_changed) == 0 } }
+      agent {
+          docker {

Review Comment:
   Looks like indentation in this file is generally 2 spaces, so this appears to break with the norm. 



##########
build-aux/Jenkinsfile.pr:
##########
@@ -61,7 +64,107 @@ pipeline {
 
   stages {
 
-    stage('erlfmt') {
+    stage('Setup Env') {
+      agent {
+          docker {

Review Comment:
   Seems like indented too much compared to existing code?



##########
build-aux/Jenkinsfile.pr:
##########
@@ -61,7 +64,68 @@ pipeline {
 
   stages {
 
+    stage('Docs Check') {
+      // Run docs `make check` stage if any docs changed
+      when { expression { return sh(returnStatus: true, script: docs_changed) == 0 } }
+      agent {
+          docker {
+              image "${DOCKER_IMAGE_BASE}-${LOW_ERLANG_VER}"
+              label 'docker'
+              args "${DOCKER_ARGS}"
+              registryUrl 'https://docker.io/'
+              registryCredentialsId 'dockerhub_creds'
+          }
+      }
+      options {
+        timeout(time: 15, unit: 'MINUTES')
+      }
+      steps {
+        sh '''
+          (cd src/docs && make check)
+        '''
+      }
+      post {
+        cleanup {
+          // UGH see https://issues.jenkins-ci.org/browse/JENKINS-41894
+          sh 'rm -rf ${WORKSPACE}/*'
+        }
+      }
+    } // Docs Check
+
+    stage('Build Docs') {
+      // Build docs separately if only docs changed. If there are other changes, docs are
+      // already built as part of `make dist`
+      when { expression { return (sh(returnStatus: true, script: docs_changed) == 0 && sh(returnStatus: true, script: other_changes) == 1)} }
+      agent {
+          docker {

Review Comment:
   Also extra indent here and below.



-- 
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.

To unsubscribe, e-mail: notifications-unsubscribe@couchdb.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org