Replaced ICG with GDoc WIP link. Tidied up content... (#348)

* Replaced ICG with GDoc WIP link. Tidied up content to make sense in website and on GitHub.

1. Put in link to WIP GDoc for ICG
2. Titied up titles of files: license, how to port, how to generate a snapsjot
3. Added license to website ToC
4. Added all the relevant repo links to repo readme /index page UNR 513
5. Added docs/README so GitHub docs make sense.
6. Tidied up ToC to match SpatialOS ToC format.

* Rebrand to "GDK for Unreal"

* Fixed links

* Fix "GDK for Unreal" branding.

* Removed trailing spaces

* Added why you should use the website

* Added explanation and removed space.

* Hid the Toc info in comments & added a temporary concepts link

.github/CONTRIBUTING.md

@@ -7,11 +7,11 @@ later releases and we’ll keep you posted on this). However, we are taking issu
 [feedback](../README.md#give-us-feedback).
 
 ## Coding standards
-See the [Unreal GDK C++ coding standards guide](../docs/contributions/unreal-gdk-coding-standards.md).
+See the [GDK for Unreal C++ coding standards guide](../docs/contributions/unreal-gdk-coding-standards.md).
 
 ## Getting started
-See [About the SpatialOS Unreal GDK](../docs/README.md) for
- details on how to get started using the Unreal GDK.
+See [About the SpatialOS GDK for Unreal](../docs/README.md) for
+ details on how to get started using the GDK for Unreal.
 
 ## Warning
 This [pre-alpha](https://docs.improbable.io/reference/latest/shared/release-policy#maturity-stages) release is for evaluation purposes only, with limited documentation -

LICENSE.md

@@ -1,9 +1,11 @@
-# Unreal
+# License
+
+## Unreal
 Your access to and use of the Unreal Engine is governed by the [Unreal Engine End User License Agreement](https://www.unrealengine.com/en-US/previous-versions/udk-licensing-resources). Please ensure that you have
 agreed to those terms before you access or use the Unreal Engine.
 
 
-# SpatialOS Unreal GDK
+## SpatialOS GDK for Unreal
 Copyright 2018 Improbable Worlds Limited (“Improbable”)
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the "Software"), to deal in the Software without restriction, including without limitation

README.md

@@ -1,37 +1,38 @@
-# The SpatialOS Unreal GDK readme (pre-alpha)
+# The SpatialOS GDK for Unreal (pre-alpha)
 
-Welcome to the SpatialOS and Unreal GDK community.
+<%(TOC)%>
 
-Our SpatialOS community shapes the functionality of the Unreal GDK, so make sure you are part of the conversation. Come and find us on [Discord](https://discordapp.com/channels/311273633307951114/339471548647866368) or talk to us on the **Feedback** section in our [forums](https://forums.improbable.io/) (use the **unreal-gdk** tag - [this link](https://forums.improbable.io/new-topic?category=Feedback&tags=unreal-gdk) takes you there and pre-fills the category and tag). You can also [sign up for SpatialOS Unreal GDK updates](http://go.pardot.com/l/169082/2018-06-15/27ld2t) direct to your mailbox.
+Welcome to the SpatialOS and GDK for Unreal community.
 
-#### What's the Unreal GDK all about?
-The **SpatialOS Unreal GDK** is an Unreal Engine 4 (UE4) [module](https://docs.unrealengine.com/en-us/Programming/UnrealBuildSystem/ModuleFiles) made by Improbable. You can use the Unreal GDK to integrate persistent multiplayer worlds into your Unreal game using the SpatialOS platform.
+Our SpatialOS community shapes the functionality of the GDK for Unreal, so make sure you are part of the conversation. Come and find us on [Discord](https://discordapp.com/channels/311273633307951114/339471548647866368) or talk to us on the **Feedback** section in our [forums](https://forums.improbable.io/) (use the **unreal-gdk** tag - [this link](https://forums.improbable.io/new-topic?category=Feedback&tags=unreal-gdk) takes you there and pre-fills the category and tag). You can also [sign up for SpatialOS GDK for Unreal updates](http://go.pardot.com/l/169082/2018-06-15/27ld2t) direct to your mailbox.
 
-Find out more about the GDK for Unreal in [our blogpost](https://improbable.io/games/blog/spatialos-unreal-gdk-pre-alpha).
+#### What's the GDK for Unreal all about?
+The SpatialOS GDK for Unreal is an Unreal Engine 4 (UE4) [module](https://docs.unrealengine.com/en-us/Programming/UnrealBuildSystem/ModuleFiles) made by Improbable. You can use the GDK for Unreal to integrate persistent multiplayer worlds into your Unreal game using the SpatialOS platform. Find out more about the GDK for Unreal in [our blogpost](https://improbable.io/games/blog/spatialos-unreal-gdk-pre-alpha).
 
-You can [sign up for SpatialOS Unreal GDK updates](http://go.pardot.com/l/169082/2018-06-15/27ld2t) direct to your mailbox.
 
-* License: use of the contents of this repository is subject to the [Improbable license](LICENSE.md)
+* License: use of the contents of this repository is subject to the [Improbable license]({{urlRoot}}/license) </br>
+(Your access to and use of the Unreal Engine is governed by the [Unreal Engine End User License Agreement](https://www.unrealengine.com/en-US/previous-versions/udk-licensing-resources?sessionInvalidated=true). Please ensure that you have agreed to those terms before you access or use the Unreal Engine.)
 * Version: pre-alpha (for evaluation only)
 * Unreal Game Development Kit repository: [github.com/spatialos/UnrealGDK](https://github.com/spatialos/UnrealGDK)
 
 ## Recommended use
-We are releasing the GDK in [pre-alpha](https://docs.improbable.io/reference/13.1/shared/release-policy#maturity-stages) so we can react to feedback and iterate on development quickly. To facilitate this, during our pre-alpha stage we don't have a formal deprecation cycle for APIs and workflows. This means that everything and anything can change. In addition, documentation is limited and some aspects of the GDK are not optimized.
+We are releasing the GDK in [pre-alpha](https://docs.improbable.io/reference/latest/shared/release-policy#maturity-stages) so we can react to feedback and iterate on development quickly. To facilitate this, during our pre-alpha stage we don't have a formal deprecation cycle for APIs and workflows. This means that everything and anything can change. In addition, documentation is limited and some aspects of the GDK are not optimized.
 
-Given this, we don’t recommend using the the Unreal GDK for games in the production phase just yet.
+Given this, we don’t recommend using the the GDK for Unreal for games in the production phase just yet.
 
 **Who is it for?**<br>
 We recommend you start using the GDK if:
-* You don’t mind the rough edges and are interested in contributing to the GDK (see our [contributions](https://docs.improbable.io/unreal/pre-alpha/contributing) policy).
+
+* You don’t mind the rough edges and are interested in contributing to the GDK (see our [contributions]({{urlRoot}}/contributing) policy).
 * You want to start evaluating the GDK or prototyping on it for a future project.
 
-Although every feature you need to build your optimal SpatialOS game may not be ready yet, this is a great time to get involved and shape the Unreal GDK. We are committed to improving the GDK rapidly, aiming for an alpha release in Fall 2018.
+Although every feature you need to build your optimal SpatialOS game may not be ready yet, this is a great time to get involved and shape the GDK for Unreal. We are committed to improving the GDK rapidly, aiming for an alpha release in Fall 2018.
 
 ## Feature List
-See the [full feature list](https://docs.improbable.io/unreal/pre-alpha/features) for what is supported in the Unreal GDK
+See the [full feature list]({{urlRoot}}/features) for what is supported in the GDK for Unreal.
 
 ## Give us feedback
-We have released the Unreal GDK this early in development because we want your feedback. Please come and talk to us about the software and the documentation via:
+We have released the GDK for Unreal this early in development because we want your feedback. Please come and talk to us about the software and the documentation via:
 
 **Discord**</br>
 Find us in the [**#unreal** channel](https://discordapp.com/channels/311273633307951114/339471548647866368). You may need to grab Discord [here](https://discordapp.com/).
@@ -42,22 +43,31 @@ Visit the **feedback** section in our [forums](https://forums.improbable.io/) an
 **GitHub issues**</br>
 Create an issue in [this repository](https://github.com/spatialos/UnrealGDK/issues).
 
-## Contributions
-We are not currently accepting public contributions - see our [contributions](https://docs.improbable.io/unreal/pre-alpha/contributing) policy. However, we are accepting issues and we do want your feedback.
-
-## Documentation
-For guidance on using the SpatialOS Unreal GDK, see the [official documentation](https://docs.improbable.io/unreal/pre-alpha/index).
+## Where to get the GDK and starter projects
+The GDK and its starter projects are available on GitHub.
+* [GDK: github.com/spatialos/UnrealGDK](https://github.com/spatialos/UnrealGDK)
+* [Third Person Shooter Game](https://github.com/spatialos/UnrealGDKThirdPersonShooter)
+* [Starter Project](https://github.com/spatialos/UnrealStarterProject)
+* [The Test Suite](https://github.com/spatialos/UnrealGDKTestSuite)
+* [The SpatialOS Unreal Engine fork](https://github.com/improbableio/UnrealEngine/tree/4.19-SpatialOSUnrealGDK) </br>
+**NOTE:** This link may give you a 404. 
+In order to get access to this fork, you need to link your GitHub account to a verified Epic Games account, and to have agreed to Epic's license. You will not be able to use the GDK for Unreal without doing this first. To do this, see the [Unreal documentation](https://www.unrealengine.com/en-US/ue4-on-github).
 
-For guidance on SpatialOS concepts see the documentation on the [SpatialOS website](https://docs.improbable.io/reference/13.1/shared/concepts/spatialos). <br/>
+## SpatialOS Documentation
+* For guidance on SpatialOS concepts see the documentation on the [SpatialOS website](https://docs.improbable.io/reference/latest/shared/concepts/spatialos). <br/>
+* For information on the SpatialOS GDK for Unreal, we recommend you use the [GDK documentation on the SpatialOS website](https://docs.improbable.io/unreal/pre-alpha/index) because the documentation is designed for the website, however, you can look at the [documentation on GitHub](https://github.com/spatialos/UnrealGDK/tree/master/docs).
 
 ## Installation and setup
-For prerequisites, installation and setup, see the [Installation and setup](https://docs.improbable.io/unreal/pre-alpha/setup-and-installing) documentation.
+For prerequisites, installation and setup, see the [Installation and setup]({{urlRoot}}/setup-and-installing.md) documentation.
 
 ## Known issues
-See the [Known issues](https://docs.improbable.io/unreal/pre-alpha/known-issues) documentation.
+See the [Known issues]({{urlRoot}}/known-issues) documentation.
+
+## Contributions
+We are not currently accepting public contributions - see our [contributions]({{urlRoot}}/contributing) policy. However, we are accepting issues and we do want your feedback.
 
 ## Troubleshooting
-Run into problems? See the [troubleshooting](docs/content/troubleshooting.md) documentation.
+Run into problems? See the [troubleshooting]({{urlRoot}}/content/troubleshooting) documentation.
 
 ## Support
 We are not supporting the pre-alpha release for game development, as this version is for evaluation only. However, please give us your [feedback](#give-us-feedback).
@@ -67,9 +77,9 @@ See the [latest roadmap (Trello board)](https://trello.com/b/7wtbtwmL/unreal-gdk
 
 ## Unreal Engine changes
 In order to transform Unreal from a single server engine to a distributed model, we had to make a small number of changes to UE4 code. We will attempt to consolidate and remove (or submit as PR to Epic) as many of these changes as possible. You can see the changes in our forked [Unreal Engine repo, `4.19-SpatialOSUnrealGDK` branch](https://github.com/improbableio/UnrealEngine/tree/4.19-SpatialOSUnrealGDK).
-> You may get a 404 error from this link. To get access, see [these instructions](https://docs.improbable.io/unreal/pre-alpha/setup-and-installing#unreal-engine-eula). <br/>
+> You may get a 404 error from this link. To get access, see [these instructions]({{urlRoot}}/setup-and-installing#unreal-engine-eula). <br/>
 
 ## Email updates
-You can [sign up for SpatialOS Unreal GDK updates](http://go.pardot.com/l/169082/2018-06-15/27ld2t) direct to your mailbox.
+You can [sign up for SpatialOS GDK for Unreal updates](http://go.pardot.com/l/169082/2018-06-15/27ld2t) direct to your mailbox.
 
 (c) 2018 Improbable

docs/README.md

@@ -0,0 +1,47 @@
+# The SpatialOS GDK for Unreal (pre-alpha) documentation on GitHub
+
+This documentation on GitHub is a copy of the [GDK documentation on the SpatialOS documentation website](https://docs.improbable.io/unreal/pre-alpha). Due to this, the internal links do not work and the image links are broken. 
+
+We recommend you use the GDK documentation on the SpatialOS documentation website and not on GitHub.
+
+
+
+[//]: # (Guide to ToC on the docs website)
+[//]: # (The website's ToC doc is here ./toc.md)
+[//]: # (Repository readme - ../README.md : the same as the website index page)
+
+[//]: # (--------------------------------)
+
+[//]: # (* SpatialOS GDK for Unreal - website index page - index.md : the same as the repository readme) 
+
+[//]: # (#### Get started)
+[//]: # (* Installation and setup - ./setup-and-installing.md)
+[//]: # (* Feature list - ./features.md)
+[//]: # (* Toolbar - ./content/toolbar.md)
+[//]: # (* Glossary - ./content/glossary.md)
+[//]: # (* License - ../LICENSE.md)
+
+[//]: # (#### Concepts)
+[//]: # (* Interop Code Generator [ICG] - content/interop.md)
+[//]: # (* Actor property handover - content/handover-between-server-workers.md)
+[//]: # (* Singleton Actors - content/singleton-actors.md)
+
+[//]: # (#### How to...)
+[//]: # (* Port an Unreal project to the GDK - content/porting-unreal-project-to-gdk)
+[//]: # (* Generate a snapshot - content/generating-a-snapshot.md)
+
+[//]: # (#### Reference)
+[//]: # (* Directory structure - content/directory-structure.md)
+[//]: # (* Helper scripts - content/helper-scripts.md)
+
+[//]: # (#### Contributing to the GDK
+[//]: # (* Contributions policy - ./contributing.md)
+[//]: # (* Coding standards - ./contributions/unreal-gdk-coding-standards.md)
+
+[//]: # (#### Troubleshooting
+[//]: # (* Troubleshooting/FAQ - content/troubleshooting.md)
+
+[//]: # (#### Known issues
+[//]: # (* Known issues - known-issues.md)
+
+[//]: # (--------------------------------)

docs/content/concepts.md

@@ -0,0 +1,11 @@
+<%(Callout type="warn" message="This [pre-alpha](https://docs.improbable.io/reference/latest/shared/release-policy#maturity-stages) release of the SpatialOS GDK for Unreal is for evaluation and feedback purposes only, with limited documentation - see the guidance on [Recommended use]({{urlRoot}}/index#recommended-use)")%>
+
+# SpatialOS concepts
+
+See the SpatialOS documentation for guidance on the SpatialOS core concepts.
+
+* [What is SpatialOS](https://docs.improbable.io/reference/latest/shared/concepts/spatialos)
+* [World, entities, components](https://docs.improbable.io/reference/latest/shared/concepts/world-entities-components)
+* [Workers and load balancing](https://docs.improbable.io/reference/latest/shared/concepts/workers-load-balancing)
+* [Interest and authority](https://docs.improbable.io/reference/latest/shared/concepts/interest-authority)
+* [Schema](https://docs.improbable.io/reference/latest/shared/concepts/schema)

docs/content/directory-structure.md

@@ -1,22 +1,22 @@
-<%(Callout type="warn" message="This [pre-alpha](https://docs.improbable.io/reference/latest/shared/release-policy#maturity-stages) release of the SpatialOS Unreal GDK is for evaluation and feedback purposes only, with limited documentation - see the guidance on [Recommended use]({{urlRoot}}/index#recommended-use)")%>
+<%(Callout type="warn" message="This [pre-alpha](https://docs.improbable.io/reference/latest/shared/release-policy#maturity-stages) release of the SpatialOS GDK for Unreal is for evaluation and feedback purposes only, with limited documentation - see the guidance on [Recommended use]({{urlRoot}}/index#recommended-use)")%>
 
-# Unreal GDK directory structure
-The table below contains the contents of the built Unreal GDK after running `BuildGDK.bat`.
+# GDK for Unreal directory structure
+The table below contains the contents of the built GDK for Unreal after running `BuildGDK.bat`.
 
 | Directory | Purpose
 |-----------|---------
-| `Binaries/ThirdParty/Improbable/` | (Not tracked in git) This folder contains all binaries required for your game project with the Unreal GDK. These files are generated by `BuildGDK.bat`.
+| `Binaries/ThirdParty/Improbable/` | (Not tracked in git) This folder contains all binaries required for your game project with the GDK for Unreal. These files are generated by `BuildGDK.bat`.
 | `build/` | (Not tracked in git) Intermediate folder used for build steps while running `BuildGDK.bat`.
-| `linting/` | Contains the linting scripts for checking the Unreal GDK.
-| `docs` | Contains the documentation for the Unreal GDK.
+| `linting/` | Contains the linting scripts for checking the GDK for Unreal.
+| `docs` | Contains the documentation for the GDK for Unreal.
 | `fastbuild` | Contains files related to installing FASTBuild. **Note** these currently only work for Improbable engineers.
 | `packages/` | (Not tracked in git) Contains the dependencies for building the Unreal SDK codegen.
-| `Plugins/SpatialGDK/SpatialGDKEditorToolbar/` | The [SpatialOS Unreal GDK toolbar]({{urlRoot}}/content/toolbar.md) within the Unreal Editor, from which you can take snapshots, generate interop code, start and stop deployments, and access the SpatialOS Inspector.
+| `Plugins/SpatialGDK/SpatialGDKEditorToolbar/` | The [SpatialOS GDK for Unreal toolbar]({{urlRoot}}/content/toolbar.md) within the Unreal Editor, from which you can take snapshots, generate interop code, start and stop deployments, and access the SpatialOS Inspector.
 | `schema` | Contains the schema files required for the GDK to interact with SpatialOS.
 | `Scripts/` | Contains a set of helper scripts used to build a GDK worker.
 | `Source/Programs/` | Contains the Unreal SDK code generator.
 | `Source/SpatialGDK/Legacy/` | Contains the source code from the [GitHub-hosted Unreal SDK](https://github.com/spatialos/UnrealSDK/tree/master/Game/Source/SpatialOS).
 | `Source/SpatialGDK/Legacy/Deprecated/` | Contains the forked source code from the [GitHub-hosted Unreal SDK](https://github.com/spatialos/UnrealSDK/tree/master/Game/Source/SpatialOS) that the GDK does not depend on. This is present purely for backwards compatibility.
 | `Source/SpatialGDK/Public/WorkerSdk/` | (Not tracked in git) Contains the [C++ worker SDK](https://docs.improbable.io/reference/latest/cppsdk/introduction) headers. You install these when you run `BuildGDK.bat`
-| `Source/SpatialGDK/Public` | Public source code of the Unreal GDK module.
-| `Source/SpatialGDK/Private` | Private source code of the Unreal GDK module.
+| `Source/SpatialGDK/Public` | Public source code of the GDK for Unreal module.
+| `Source/SpatialGDK/Private` | Private source code of the GDK for Unreal module.

docs/content/generating-a-snapshot.md

@@ -1,10 +1,10 @@
-<%(Callout type="warn" message="This [pre-alpha](https://docs.improbable.io/reference/latest/shared/release-policy#maturity-stages) release of the SpatialOS Unreal GDK is for evaluation and feedback purposes only, with limited documentation - see the guidance on [Recommended use]({{urlRoot}}/index#recommended-use)")%>
+<%(Callout type="warn" message="This [pre-alpha](https://docs.improbable.io/reference/latest/shared/release-policy#maturity-stages) release of the SpatialOS GDK for Unreal is for evaluation and feedback purposes only, with limited documentation - see the guidance on [Recommended use]({{urlRoot}}/index#recommended-use)")%>
 
-# Generating a snapshot
+# How to generate a snapshot
 
 If you're not familiar with snapshots in the context of SpatialOS, please look at the [full snapshot documentation](https://docs.improbable.io/reference/latest/shared/operate/snapshots) (SpatialOS documentation).
 
-The SpatialOS Unreal GDK snapshots contain two kinds of entities: critical entities and placeholders.
+The SpatialOS GDK for Unreal snapshots contain two kinds of entities: critical entities and placeholders.
 
 ### Critical entities
 
@@ -21,7 +21,7 @@ These entities exists only to set up server-worker boundaries in a way that is e
 
 ## Generating a snapshot
 
-To generate a snapshot, use the **Snapshot** button on the SpatialOS Unreal GDK toolbar in the Unreal Editor:
+To generate a snapshot, use the **Snapshot** button on the SpatialOS GDK for Unreal toolbar in the Unreal Editor:
 
  ![Snapshot]({{assetRoot}}assets/screen-grabs/snapshot.png)