From 017db422c340a637ad3a0de846991eb74c12491a Mon Sep 17 00:00:00 2001
From: Felipe Duarte <fduarte@squareup.com>
Date: Tue, 2 Aug 2022 17:45:29 -0400
Subject: [PATCH] Small clean up on the documentation

- Add folder site/ to .gitignore so it doesn't show as untracked when
building the documentation locally
- Remove docs/releasing.md in favor of the same file that's exists
at the root folder
- Update Dokka Gradle plugin to 1.7.10
- Fix the API javadocs directory to match with what the build script
is expecting: docs/1.x
---
 .gitignore                       |  1 +
 docs/releasing.md                | 47 --------------------------------
 paparazzi/build.gradle           |  2 +-
 paparazzi/paparazzi/build.gradle |  2 +-
 4 files changed, 3 insertions(+), 49 deletions(-)
 delete mode 100644 docs/releasing.md

diff --git a/.gitignore b/.gitignore
index fc8345e29..db01d8c68 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,3 +17,4 @@ generated
 docs/1.x
 docs/changelog.md
 docs/index.md
+site/
diff --git a/docs/releasing.md b/docs/releasing.md
deleted file mode 100644
index ffe59a945..000000000
--- a/docs/releasing.md
+++ /dev/null
@@ -1,47 +0,0 @@
-Releasing
-=========
-
-1. Update `CHANGELOG.md`.
-
-2. Set versions:
-
-    ```
-    export RELEASE_VERSION=X.Y.Z
-    export NEXT_VERSION=X.Y.Z-SNAPSHOT
-    ```
-
-3. Update, build, and upload:
-
-    ```
-    sed -i "" \
-      "s/VERSION_NAME=.*/VERSION_NAME=$RELEASE_VERSION/g" \
-      gradle.properties
-    sed -i "" \
-      "s/\"app.cash.paparazzi:\([^\:]*\):[^\"]*\"/\"app.cash.paparazzi:\1:$RELEASE_VERSION\"/g" \
-      `find . -name "README.md"`
-    ./gradlew clean uploadArchives
-    ```
-
-4. Visit [Sonatype Nexus](https://oss.sonatype.org/) to promote the artifact. Or drop it if there is a problem!
-
-5. Tag the release, prepare for the next one, and push to GitHub.
-
-    ```
-    git commit -am "Prepare for release $RELEASE_VERSION."
-    git tag -a parent-$RELEASE_VERSION -m "Version $RELEASE_VERSION"
-    sed -i "" \
-      "s/VERSION_NAME=.*/VERSION_NAME=$NEXT_VERSION/g" \
-      gradle.properties
-    git commit -am "Prepare next development version."
-    git push && git push --tags
-    ```
-
-
-Prerequisites
--------------
-
-In `~/.gradle/gradle.properties`, set the following:
-
- * `mavenCentralUsername` - Sonatype username for releasing to `app.cash`.
- * `mavenCentralPassword` - Sonatype password for releasing to `app.cash`.
-
diff --git a/paparazzi/build.gradle b/paparazzi/build.gradle
index 658ba58e9..49e0a3116 100644
--- a/paparazzi/build.gradle
+++ b/paparazzi/build.gradle
@@ -15,7 +15,7 @@ buildscript {
     classpath deps.plugins.android
     classpath 'com.vanniktech:gradle-maven-publish-plugin:0.20.0'
     classpath 'org.ajoberstar.grgit:grgit-gradle:5.0.0'
-    classpath 'org.jetbrains.dokka:dokka-gradle-plugin:1.6.21'
+    classpath 'org.jetbrains.dokka:dokka-gradle-plugin:1.7.10'
     classpath deps.plugins.versions
     classpath deps.plugins.spotless
   }
diff --git a/paparazzi/paparazzi/build.gradle b/paparazzi/paparazzi/build.gradle
index b4cdaa559..45da9dba4 100644
--- a/paparazzi/paparazzi/build.gradle
+++ b/paparazzi/paparazzi/build.gradle
@@ -71,7 +71,7 @@ dependencies {
 }
 
 tasks.named("dokkaGfm").configure {
-  outputDirectory = rootProject.file("docs/1.x")
+  outputDirectory = rootProject.file("../docs/1.x")
 
   dokkaSourceSets.named("main") {
     configureEach {