docs: add user facing documentation for real-time logs

runatlantis.io/.vuepress/config.js

@@ -35,9 +35,13 @@ module.exports = {
             {text: 'Home', link: '/'},
             {text: 'Guide', link: '/guide/'},
             {text: 'Docs', link: '/docs/'},
+            {text: 'Streaming Logs', link: '/logs/'},
             {text: 'Blog', link: 'https://medium.com/runatlantis'}
         ],
         sidebar: {
+            '/logs/': [
+                '',
+            ],
             '/guide/': [
                 '',
                 'test-drive',

runatlantis.io/guide/testing-locally.md

@@ -310,6 +310,10 @@ atlantis plan -- -target=resource -var 'foo=bar'
 If you'd like to `apply`, type a comment: `atlantis apply`. You can use the `-d` or `-w` flags to point
 Atlantis at a specific plan. Otherwise it tries to apply the plan for the root directory.
 
+## Real-time logs
+The real-time terraform output for your command can be found by clicking into the status check for a given project in a PR which
+links to the log-streaming UI. This is a terminal UI where you can view your commands executing in real-time. 
+
 ## Next Steps
 * If things are working as expected you can `Ctrl-C` the `atlantis server` command and the `ngrok` command.
 * Hopefully Atlantis is working with your repo and you're ready to move on to a [production-ready deployment](../docs/deployment.html).

runatlantis.io/logs/README.md

@@ -0,0 +1,22 @@
+# Real-time Atlantis logs
+
+## Getting Started
+Atlantis supports streaming terraform logs in real time by default. Currently, only two commands are supported
+
+### atlantis plan 
+When a user runs atlantis plan in their PR, Atlantis will add a atlantis/plan status check for all the projects as shown below: 
+![Plan Command](./images/plan.png)
+
+The user can then navigate to the log-streaming UI by navigating to the link in the github check for their project. This will open up a new tab which shows the terraform logs of their operation in real time. 
+![Plan Output](./images/plan_output.png)
+
+### atlantis apply
+When a user runs atlantis apply in their PR, Atlantis will add a atlantis/apply status check for all the projects as shown below: 
+![Apply Command](./images/apply.png)
+
+The user can then navigate to the log-streaming UI by navigating to the link in the github check for their project. This will open up a new tab which shows the terraform logs of their operation in real time. 
+![Apply Output](./images/apply_output.png)
+
+## Future Work 
+In the future, users will also be able to persist the logs into a storage backend of their choice. 
+