Clean up README and RELEASING; remove more docs stuff
MODIFY
.gitignore
.gitignore
# macOS
.DS_Store
-# Compiled class file
-*.class
-
-# Log file
-*.log
-
-# BlueJ files
-*.ctxt
-
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
-# Package Files #
-*.jar
-*.war
-*.nar
-*.ear
-*.zip
-*.tar.gz
-*.rar
-
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
-
-# Gradle
-out/
-.gradle/
-build/
-local.properties
-
-# Intellij
-*.iml
-.idea/
-
# cocoapods-generate
gen/
@@ -53,10 +19,5 @@ xcuserdata/
# Sample workspace
SampleApp.xcworkspace
-# Special Mkdocs files
-docs/kotlin/api/
-docs/swift/api/
-site/
-
# ios-snapshot-test-case Failure Diffs
FailureDiffs/

MODIFY
RELEASING.md
RELEASING.md
@@ -62,116 +62,7 @@ and assign it to @bencochran or @aquageek.*
git push origin trunk
```
-1. Publish the website. See below.
-
-## Deploying the documentation website
-
-Official Workflow documentation lives at <https://squareup.github.io/workflow>. The website content
-consists of three parts:
-
-1. Markdown documentation: Lives in the `docs/` folder, and consists of a set of hand-written
- Markdown files that document high-level concepts. The static site generator
- [mkdocs](https://www.mkdocs.org/) (with [Material](https://squidfunk.github.io/mkdocs-material/)
- theming) is used to convert the Markdown to static, styled HTML.
-1. Kotlin API reference: Kdoc embedded in Kotlin source files is converted to GitHub-flavored
- Markdown by Dokka and then included in the statically-generated website.
-1. Swift API reference: Markup comments from Swift files are converted Markdown by
- [Sourcedocs](https://github.com/eneko/SourceDocs) and then included in the statically-generated
- website.
-
-**Note: The documentation site is automatically built and deployed whenever a version tag is pushed.
-You only need these steps if you want to work on the site locally.**
-
-### Setting up the site generators
-
-If you've already done this, you can skip to _Deploying the website to production_ below.
-
-#### Kotlin: Dokka
-
-Dokka runs as a Gradle plugin, so you need to be able to build the Kotlin source with Gradle, but
-that's it. To generate the docs manually, run:
-
-```bash
-cd kotlin
-./gradlew dokka
-```
-
-#### Swift: Sourcedocs
-
-Sourcedocs generates a Markdown site from Swift files. You need Ruby, rubygems,
-bundler (2.x), Xcode 10.2+, CocoaPods, and of course Sourcedocs itself, to run it. Assuming you've
-already got Xcode, Ruby, and rubygems set up, install the rest of the dependencies:
-
-```bash
-gem install bundler cocoapods
-brew install sourcedocs
-```
-
-If that succeeded, you need to generate an Xcode project before running Sourcedocs:
-
-```bash
-cd swift/Samples/SampleApp/
-bundle exec pod install
-# If this is your first time running CocoaPods, that will fail and you'll need to run this instead:
-#bundle exec pod install --repo-update
-```
-
-You can manually generate the docs to verify everything is working correctly by running:
-
-```bash
-#cd swift/Samples/SampleApp/
-sourcedocs generate -- -scheme Workflow -workspace SampleApp.xcworkspace
-sourcedocs generate -- -scheme WorkflowUI -workspace SampleApp.xcworkspace
-sourcedocs generate -- -scheme WorkflowTesting -workspace SampleApp.xcworkspace
-```
-
-Note that currently sourcedocs only supports Xcode 10, if you run it with Xcode 11 you might see
-an error about Catalyst and only empty READMEs will get generated.
-
-#### mkdocs
-
-Mkdocs is written in Python, so you'll need Python 3 and pip in order to run it. Assuming those are
-set up, run:
-
-```bash
-pip install -r requirements.txt
-```
-
-Generate the site manually with:
-
-```bash
-mkdocs build
-```
-
-While you're working on the documentation files, you can run the site locally with:
-
-```bash
-mkdocs serve
-```
-
-### Deploying the website to production
-
-**Note: The documentation site is automatically built and deployed by a Github Workflow whenever a
-version tag is pushed. You only need these steps if you want to publish the site manually.**
-
-Before deploying the website for real, you need to export our Google Analytics key in an environment
-variable so that it will get added to the HTML. Get the key from one of the project maintainers,
-then add the following to your `.bashrc` and re-source it:
-
-```bash
-export WORKFLOW_GOOGLE_ANALYTICS_KEY=UA-__________-1
-```
-
-Now you're ready to publish the site! Just choose a tag or SHA to deploy from, and run:
-
-```bash
-./deploy_website.sh TAG_OR_SHA
-# For example:
-#./deploy_website.sh v0.18.0
-```
-
-This will clone the repo to a temporary directory, checkout the right SHA, build Kotlin and Swift
-API docs, generate HTML, and push the newly-generated content to the `gh-pages` branch on GitHub.
+1. Publish the website. See https://github.com/square/workflow/blob/trunk/RELEASING.md.
### Validating Markdown
@@ -190,41 +81,3 @@ Run the linter using the `lint_docs.sh`:
```
Rules can be configured by editing `.markdownlint.rb`.
-
----
-
-## Kotlin Notes
-
-### Development
-
-To build and install the current version to your local Maven repository (`~/.m2`), run:
-
-```bash
-./gradlew clean installArchives
-```
-
-### Deploying
-
-#### Configuration
-
-In order to deploy artifacts to a Maven repository, you'll need to set 4 properties in your private
-Gradle properties file (`~/.gradle/gradle.properties`):
-
-```
-RELEASE_REPOSITORY_URL=<url of release repository>
-SNAPSHOT_REPOSITORY_URL=<url of snapshot repository
-SONATYPE_NEXUS_USERNAME=<username>
-SONATYPE_NEXUS_PASSWORD=<password>
-```
-
-#### Snapshot Releases
-
-Double-check that `gradle.properties` correctly contains the `-SNAPSHOT` suffix, then upload
-snapshot artifacts to Sonatype just like you would for a production release:
-
-```bash
-./gradlew clean build && ./gradlew uploadArchives --no-parallel --no-daemon
-```
-
-You can verify the artifacts are available by visiting
-https://oss.sonatype.org/content/repositories/snapshots/com/squareup/workflow/.

DELETE
requirements.txt
-mkdocs==1.1.2
-mkdocs-material==5.2.2
-mkdocs-redirects==1.0.0

Clean up README and RELEASING; remove more docs stuff