Relocate documentation (#2266)

.github/workflows/build_doc.yml

@@ -24,10 +24,10 @@ jobs:
       working-directory: arrow-libs
       run: ./gradlew dokka
     - name: Validate documentation
-      working-directory: arrow-docs
+      working-directory: arrow-site
       run: ./gradlew runAnk
     - name: Build site
       working-directory: arrow-site
       run: |
          bundle install --gemfile Gemfile --path vendor/bundle
-         bundle exec jekyll build -s docs
+         bundle exec jekyll build -s build/site

.github/workflows/publish_doc.yml

@@ -47,13 +47,13 @@ jobs:
       working-directory: arrow-libs
       run: ./gradlew dokka
     - name: "Validate documentation"
-      working-directory: arrow-docs
+      working-directory: arrow-site
       run: ./gradlew runAnk
     - name: "Latest release: build (landing page + docs/)"
       if: steps.versions.outputs.new-release-version-exists == '1'
       working-directory: arrow-site
       run: |
-        bundle exec jekyll build -b docs -s docs
+        bundle exec jekyll build -b docs -s build/site
         tree _site > $BASEDIR/logs/content_docs.log
     - name: "Latest release: publish (landing page + docs/)"
       if: steps.versions.outputs.new-release-version-exists == '1'
@@ -69,7 +69,7 @@ jobs:
       working-directory: arrow-site
       run: |
         SHORT_VERSION=$(echo ${{ steps.versions.outputs.release-version }} | cut -d. -f1-2)
-        bundle exec jekyll build -b docs/${SHORT_VERSION} -s docs
+        bundle exec jekyll build -b docs/${SHORT_VERSION} -s build/site
         tree _site > $BASEDIR/logs/content_docs-${SHORT_VERSION}.log
     - name: "Latest release: publish release directory (docs/<major.minor>)"
       if: steps.versions.outputs.new-release-version-exists == '1'
@@ -85,7 +85,7 @@ jobs:
     - name: "Next version: build (/docs/next)"
       working-directory: arrow-site
       run: |
-        bundle exec jekyll build -b docs/next -s docs
+        bundle exec jekyll build -b docs/next -s build/site
         tree _site > $BASEDIR/logs/content_docs-next.log
     - name: "Next version: publish (/docs/next)"
       working-directory: arrow-site

.gitignore

@@ -116,9 +116,6 @@ vendor
 # Ruby
 Gemfile.lock
 
-# Site
-arrow-site/docs
-
 ### Intellij Patch ###
 # Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
 

CONTRIBUTING.md

@@ -58,7 +58,7 @@ In order to generate the documentation and validate it:
 cd arrow-libs
 ./gradlew dokka
 
-cd ../arrow-docs
+cd ../arrow-site
 ./gradlew runAnk
 ```
 

arrow-libs/gradle/apidoc-creation.gradle

@@ -19,7 +19,7 @@ apply plugin: "org.jetbrains.dokka"
 //dokka log spam `Can't find node by signature` comes from https://github.com/Kotlin/dokka/issues/269
 dokka {
     outputFormat = 'jekyll'
-    outputDirectory = "${rootDir}/../arrow-docs/docs/apidocs"
+    outputDirectory = "${rootDir}/../arrow-site/docs/apidocs"
     configuration {
         includes = ['README.md']
         reportUndocumented = false

arrow-docs/build.gradle → arrow-site/build.gradle

@@ -37,7 +37,7 @@ dependencies {
 apply plugin: 'ank-gradle-plugin'
 
 ank {
-    source = file("${projectDir}/docs")
-    target = file("${rootDir}/../arrow-site/docs")
+    source = file("${rootDir}/docs")
+    target = file("${rootDir}/build/site")
     classpath = sourceSets.main.runtimeClasspath
 }

arrow-docs/docs/landingpage/core-home-code.md → arrow-site/docs/_code/core-home-code.md

@@ -1,3 +1,6 @@
+---
+library: core
+---
 {: data-executable="true"}
 ```kotlin:ank
 import arrow.core.Either

arrow-docs/docs/landingpage/fx-home-code.md → arrow-site/docs/_code/fx-home-code.md

@@ -1,3 +1,6 @@
+---
+library: fx
+---
 ```kotlin:ank:playground
 import arrow.fx.coroutines.parTraverse
 import arrow.fx.coroutines.parMapN
@@ -23,6 +26,8 @@ fun employee(name: String, company: Company): Employee =
 
 suspend fun main() {
     //sampleStart
+
+
     //maps each function to `::employee` in parallel
     val audrey = parMapN({ "Audrey" }, { company("Arrow") }, ::employee) 
     val pepe   = parMapN({  "Pepe"  }, { company("Arrow") }, ::employee)

arrow-site/docs/landingpage/meta-home-code.md → arrow-site/docs/_code/meta-home-code.md

@@ -1,5 +1,9 @@
+---
+library: meta
+---
 ```kotlin
 //sampleStart
+
 val Meta.helloWorld: CliPlugin get() =
   "Hello World" {
     meta(

arrow-docs/docs/landingpage/optics-home-code.md → arrow-site/docs/_code/optics-home-code.md

@@ -1,3 +1,6 @@
+---
+library: optics
+---
 {: data-executable="true"}
 ```kotlin:ank
 package example

arrow-site/docs/_includes/_header.html

@@ -3,15 +3,15 @@
     <div class="header-flex">
       <div class="header-text">
         <h1 id="header-text">{{site.data.commons.description}}</h1>
-        {% for library in site.data.code.libraries %}
-        <div id="{{ library }}-code-block" class="browser-content">
+        {% assign codeCol = site.code %}
+        {% for code in codeCol %}
+        <div id="{{code.library}}-code-block" class="browser-content">
           <ul class="browser-header">
             <li></li>
             <li></li>
             <li></li>
           </ul>
-          {% capture library_snippet %}{% include_relative landingpage/{{ library }}-home-code.md  %}{% endcapture %}
-          <div class="browser-code">{{ library_snippet | markdownify }}</div>
+          <div class="browser-code">{{ code }}</div>
         </div>
         {% endfor %}
       </div>