Add docusaurus for website (wix#491)

* add docusaurus for website * add docusaurus to the CI build * Add documentation for 6.x * only deploy documentation on master branch
metinkiperr · Jan 23, 2018 · 6a5b528 · 6a5b528
1 parent f546a21
commit 6a5b528
Show file tree

Hide file tree

Showing 78 changed files with 3,775 additions and 35 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -50,6 +50,20 @@ matrix:
       script:
       - ./scripts/demo-projects.ios.sh
 
+    # Website
+    - language: node_js
+      env:
+        - NAME='Website - master'
+      node_js: 8
+      script:
+      - git config --global user.email "$GIT_USER@users.noreply.github.com"
+      - git config --global user.name "Daniel Schmidt"
+      - echo "machine github.com login $GIT_USER password $GIT_TOKEN" > ~/.netrc
+      - cd website && npm install && GIT_USER=$GIT_USER CURRENT_BRANCH=docusaurus npm run publish-gh-pages
+      branches:
+        only:
+          - master
+
 branches:
   only:
   - master

diff --git a/docs/APIRef.ActionsOnElement.md b/docs/APIRef.ActionsOnElement.md
@@ -1,4 +1,7 @@
-# Actions on Element
+---
+id: APIRef.ActionsOnElement
+title: Actions on Element
+---
 
 Detox uses **Matchers** to find UI `elements` in your app, **Actions** to emulate user interaction with those `elements` and **Expectations** to verify values on those `elements`.
 

diff --git a/docs/APIRef.Artifacts.md b/docs/APIRef.Artifacts.md
@@ -1,4 +1,7 @@
-# Artifacts
+---
+id: APIRef.Artifacts
+title: Artifacts
+---
 
 Artifacts currently include only logs from the app process.
 

diff --git a/docs/APIRef.Configuration.md b/docs/APIRef.Configuration.md
@@ -1,4 +1,7 @@
-# Configuration Options
+---
+id: APIRef.Configuration
+title: Configuration Options
+---
 
 ## Configuring package.json 
 ### Device Configuration

diff --git a/docs/APIRef.DetoxCLI.md b/docs/APIRef.DetoxCLI.md
@@ -1,4 +1,7 @@
-# Detox Command Line Tools (detox-cli)
+---
+id: APIRef.DetoxCLI
+title: Detox Command Line Tools (detox-cli)
+---
 
 `detox-cli` lets you operate Detox from command line.
 

diff --git a/docs/APIRef.DetoxObjectAPI.md b/docs/APIRef.DetoxObjectAPI.md
@@ -1,4 +1,7 @@
-# The `detox` Object
+---
+id: APIRef.DetoxObjectAPI
+title: The `detox` Object
+---
 
 `detox` is globally available in every test file, though currently it is only used in the setup/init file.
 

diff --git a/docs/APIRef.DeviceObjectAPI.md b/docs/APIRef.DeviceObjectAPI.md
@@ -1,4 +1,7 @@
-# The `device` Object
+---
+id: APIRef.DeviceObjectAPI
+title: The `device` Object
+---
 
 `device` is globally available in every test file, it enables control over the current attached device (currently only simulators are supported).
 

diff --git a/docs/APIRef.Expect.md b/docs/APIRef.Expect.md
@@ -1,4 +1,7 @@
-# Expect
+---
+id: APIRef.Expect
+title: Expect
+---
 
 Detox uses **Matchers** to find UI `elements` in your app, **Actions** to emulate user interaction with those `elements` and **Expectations** to verify values on those `elements`.
 

diff --git a/docs/APIRef.Matchers.md b/docs/APIRef.Matchers.md
@@ -1,4 +1,7 @@
-# Matchers
+---
+id: APIRef.Matchers
+title: Matchers
+---
 
 Detox uses **Matchers** to find UI `elements` in your app, **Actions** to emulate user interaction with those `elements` and **Expectations** to verify values on those `elements`.
 

diff --git a/docs/APIRef.MockingOpenFromURL.md b/docs/APIRef.MockingOpenFromURL.md
@@ -1,4 +1,7 @@
-## Mocking Open from URL (Deep Links)
+---
+id: APIRef.MockingOpenFromURL
+title: Mocking Open from URL (Deep Links)
+---
 
 You can mock opening the app from URL to test your app's deep link handling mechanism.
 

diff --git a/docs/APIRef.MockingUserNotifications.md b/docs/APIRef.MockingUserNotifications.md
@@ -1,5 +1,7 @@
-
-# Mocking User Notifications
+---
+id: APIRef.MockingUserNotifications
+title: Mocking User Notifications
+---
 
 Detox supports mocking user notifications for iOS apps.
 

diff --git a/docs/APIRef.TestLifecycle.md b/docs/APIRef.TestLifecycle.md
@@ -1,4 +1,7 @@
-# Test Lifecycle
+---
+id: APIRef.TestLifecycle
+title: Test Lifecycle
+---
 
 Detox is test runner independent, and we encourge you to choose your own test runner, but for the sake of demonstration we will use `mocha`'s syntax.
 

diff --git a/docs/APIRef.waitFor.md b/docs/APIRef.waitFor.md
@@ -1,4 +1,7 @@
-# Manual Synchronization Using `waitFor`
+---
+id: APIRef.waitFor
+title: Manual Synchronization Using `waitFor`
+---
 
 In most cases, tests should be automatically synchronized with the app. When synchronization doesn't work, you have a fail-safe by using `waitFor`. This API polls using the given expectation continuously until the expectation is met. Use manual synchronization with `waitFor` only as a **last resort**. Polling for expectations isn't exactly a best practice.
 

diff --git a/docs/Guide.Contributing.md b/docs/Guide.Contributing.md
@@ -1,4 +1,7 @@
-# Contributing to Detox
+---
+id: Guide.Contributing
+title: Contributing
+---
 
 ## Prerequisites
 

diff --git a/docs/Guide.DebuggingInXcode.md b/docs/Guide.DebuggingInXcode.md
@@ -1,4 +1,7 @@
-# Debugging Apps in Xcode During a Test
+---
+id: Guide.DebuggingInXcode
+title: Debugging Apps in Xcode During a Test
+---
 
 > Advanced users might need to natively debug their app inside Xcode during a Detox test. This is mostly useful for invesigating weird crahses or when contributing to Detox itself.
 

diff --git a/docs/Guide.DevelopingWhileWritingTests.md b/docs/Guide.DevelopingWhileWritingTests.md
@@ -1,4 +1,7 @@
-# Developing Your App While Writing Tests
+---
+id: Guide.DevelopingWhileWritingTests
+title: Developing Your App While Writing Tests
+---
 
 > If your app requires active development, such as adding testID fields for tests, this is a good workflow. It allows you to work both on your app and your tests at the same time.
 

diff --git a/docs/Guide.Jest.md b/docs/Guide.Jest.md
@@ -1,4 +1,7 @@
-# Jest as Test Runner
+---
+id: Guide.Jest
+title: Jest
+---
 
 ## Usage
 

diff --git a/docs/Guide.Migration.md b/docs/Guide.Migration.md
@@ -1,4 +1,7 @@
-# Migration Guide
+---
+id: Guide.Migration
+title: Migration Guide
+---
 
 We are improving detox API as we go along, sometimes these changes require us to break the API in order for it to make more sense and. These migration guides refer to breaking changes.
 

diff --git a/docs/Guide.Mocking.md b/docs/Guide.Mocking.md
@@ -1,4 +1,7 @@
-# Advanced Mocking With Detox 
+---
+id: Guide.Mocking
+title: Mocking
+---
 
 Mocking is an important part of testing. You may want to alter some behavior of your app during test and replace it with a mock. Here are some example reasons why this could be useful:
 

diff --git a/docs/Guide.RunningLocally.md b/docs/Guide.RunningLocally.md
@@ -1,4 +1,8 @@
-# Running Tests Locally on Your Machine
+---
+id: Guide.RunningLocally
+title: Running Locally
+sidebar_label: Running Tests Locally
+---
 
 > If your app is ready and does not require any active development, you can write your tests using this workflow and run them locally on your machine. This is convenient for developing your test suite without actively developing your app.
 

diff --git a/docs/Guide.RunningOnCI.md b/docs/Guide.RunningOnCI.md
@@ -1,4 +1,7 @@
-# Running Tests on CI (Travis or Bitrise)
+---
+id: Guide.RunningOnCI
+title: Running On CI
+---
 
 > When your test suite is finally ready, it should be set up to run automatically on your CI server on every git push. This will alert you if new changes to the app break existing functionality.
 

diff --git a/docs/Introduction.Android.md b/docs/Introduction.Android.md
@@ -1,4 +1,7 @@
-# Detox for Android
+---
+id: Introduction.Android
+title: Detox for Android
+---
 
 ## Setup
 Detox 7 was updated to support Android gradle plugin 3.0.0. This is a breaking change that makes it impossible to support previous Android gradle plugin versions.

diff --git a/docs/Introduction.GettingStarted.md b/docs/Introduction.GettingStarted.md
@@ -1,4 +1,7 @@
-# Getting Started
+---
+id: Introduction.GettingStarted
+title: Getting Started
+---
 
 This is a step-by-step guide for adding Detox to your React Native project.
 

diff --git a/docs/Introduction.HowDetoxWorks.md b/docs/Introduction.HowDetoxWorks.md
@@ -1,4 +1,7 @@
-# How Detox Works
+---
+id: Introduction.HowDetoxWorks
+title: How Detox Works
+---
 
 Detox is an end-to-end testing framework. This means it runs your app on an actual device/simulator and interacts with it just like a real user would. This type of tests can give a lot of confidence for releasing your app and help automate a manual QA process. If you're coming from a web background, it's very similar in concept to [protractor](http://www.protractortest.org/#/).
 

diff --git a/docs/Introduction.Workflows.md b/docs/Introduction.Workflows.md
@@ -1,4 +1,7 @@
-# Recommended Workflows With Detox
+---
+id: Introduction.Workflows
+title: Workflows
+---
 
 There are multiple recommended ways to work with Detox and make it a part of your development process. Choose the best workflow for your needs:
 

diff --git a/docs/Introduction.WritingFirstTest.md b/docs/Introduction.WritingFirstTest.md
@@ -1,5 +1,7 @@
-
-# Writing Your First Passing Test
+---
+id: Introduction.WritingFirstTest
+title: Writing Your First Test
+---
 
 This tutorial assumes you've already installed Detox successfully on a working React Native project.
 

diff --git a/docs/More.AndroidSupportStatus.md b/docs/More.AndroidSupportStatus.md
@@ -1,4 +1,7 @@
-# Android Support - Status Page
+---
+id: More.AndroidSupportStatus
+title: Android Support - Status Page
+---
 
 As we are wrapping up Android support for Detox, there's already a pretty hefty chunk of Detox for Android already implemented, we decided to start releasing it as we go along, just like we did with the iOS implementation.
 

diff --git a/docs/More.DesignPrinciples.md b/docs/More.DesignPrinciples.md
@@ -1,4 +1,7 @@
-# Detox Design Principles
+---
+id: More.DesignPrinciples
+title: Design Principles
+---
 
 Traditionally, end-to-end tests on mobile are riddled with inherent issues, making the testing process difficult and lowering ROI for developers. We believe that the only way to solve these issues at the core is by changing some of the basic principles of our approach.
 

diff --git a/docs/More.Roadmap.md b/docs/More.Roadmap.md
@@ -1,4 +1,7 @@
-# Detox Development Roadmap
+---
+id: More.Roadmap
+title: Roadmap
+---
 
 We have some very interesting plans for Detox, this is the place to discuss and share them.
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,3 +1,9 @@
+---
+id: README
+title: detox
+sidebar_label: Overview
+---
+
 # Detox Documentation
 
 ## Introduction

diff --git a/docs/Troubleshooting.Flakiness.md b/docs/Troubleshooting.Flakiness.md
@@ -1,4 +1,7 @@
-# Dealing With Flakiness in Tests
+---
+id: Troubleshooting.Flakiness
+title: Dealing With Flakiness in Tests
+---
 
 > What is a flaky test?
 

diff --git a/docs/Troubleshooting.Installation.md b/docs/Troubleshooting.Installation.md
@@ -1,4 +1,7 @@
-# Troubleshooting Detox Installation
+---
+id: Troubleshooting.Installation
+title: Installation
+---
 
 * [No simulators found](#no-simulators-found)
 

diff --git a/docs/Troubleshooting.RunningTests.md b/docs/Troubleshooting.RunningTests.md
@@ -1,5 +1,7 @@
-# Troubleshooting a Test That Keeps Failing
-
+---
+id: Troubleshooting.RunningTests
+title: Failing Tests
+---
 * [Enable verbose mode](#enable-verbose-mode)
 * [Syntax Error: Unxpected Token](#syntax-error-unxpected-token)
 * [Can't find my component even though I added testID to its props](#cant-find-my-component-even-though-i-added-testid-to-its-props)

diff --git a/docs/Troubleshooting.Synchronization.md b/docs/Troubleshooting.Synchronization.md
@@ -1,4 +1,7 @@
-# Dealing With Synchronization Issues in Tests
+---
+id: Troubleshooting.Synchronization
+title: Dealing With Synchronization Issues in Tests
+---
 
 Traditionally, one of the most difficult aspects of E2E testing is synchronizing the test scenario with the app. Complex operations inside the app (like accessing servers or performing animations) often take variable amount of time to complete. We can't continue the test until they've completed. How can we synchronize the test with these operations?
 

diff --git a/website/.gitignore b/website/.gitignore
@@ -0,0 +1,11 @@
+node_modules
+.DS_Store
+lib/core/metadata.js
+lib/core/MetadataBlog.js
+website/translated_docs
+website/build/
+website/yarn.lock
+website/node_modules
+
+website/i18n/*
+!website/i18n/en.json