Skip to content
This repository has been archived by the owner on Aug 29, 2024. It is now read-only.

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

Merged
merged 8 commits into from
Sep 17, 2018
Merged

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

merged 8 commits into from
Sep 17, 2018

Conversation

ElleEss
Copy link
Contributor

@ElleEss ElleEss commented Sep 14, 2018 •
edited
Loading

...to make sense in website and on GitHub.

Documentation

  1. Put in link to WIP GDoc for ICG.
  2. Titied up titles of files: license, how to port, how to generate a snapshot.
  3. Added license to website ToC for website docs.
  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.
  7. Rebranded "GDK for Unreal" UNR 513.

Primary reviewers

@Vatyx @anne-edwards

@ElleEss
Replaced ICG with GDoc WIP link. Tidied up content to make sense in w…
221f8b1 
…ebsite 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.
@improbable-prow-robot improbable-prow-robot added the size/L Denotes a PR that changes 150-299 lines, ignoring generated files. label Sep 14, 2018
@improbable-prow-robot improbable-prow-robot added size/XL Denotes a PR that changes 300-599 lines, ignoring generated files. and removed size/L Denotes a PR that changes 150-299 lines, ignoring generated files. labels Sep 14, 2018
anne-edwards
anne-edwards reviewed Sep 14, 2018
View reviewed changes
README.md Outdated
@@ -1,34 +1,35 @@
# The SpatialOS Unreal GDK readme (pre-alpha)
# The SpatialOS Unreal GDK (pre-alpha)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"GDK for Unreal"?

anne-edwards
anne-edwards reviewed Sep 14, 2018
View reviewed changes
README.md Outdated
# The SpatialOS Unreal GDK readme (pre-alpha)
# The SpatialOS Unreal GDK (pre-alpha)

<%(TOC)%>

Welcome to the SpatialOS and Unreal GDK community.

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.

#### What's the Unreal GDK all about?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"GDK for Unreal"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(NOTE: there are a few more - I won't flag them all!)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got them all, ta - the doc was outside my search and replace.

anne-edwards
anne-edwards reviewed Sep 14, 2018
View reviewed changes
docs/index.md Outdated
@@ -72,3 +81,7 @@ In order to transform Unreal from a single server engine to a distributed model,

## 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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these new lines needed?

(I feel like a developer! 🤓)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HA HA HA HA! It's a copy and paste - the MD and HTML generator just ignores them...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file is hard for a human to read without the spaces there

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough!
🤖

anne-edwards
anne-edwards reviewed Sep 14, 2018
View reviewed changes
README.md Outdated
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), however, you can look at the [documentation on GitHub](https://github.com/spatialos/UnrealGDK/tree/master/docs).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth saying why we recommend this? (I just know that I personally don't like being told to do something if nobody tells me why and there seems to be an easier way)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have an explanation on the top of the docs/readme file which this links to here https://github.com/spatialos/UnrealGDK/tree/master/docs. So if you want to know, the answer is a click through. Thinking adding the explanation here as well might be more clutter on an already cluttered page?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, makes sense.

Although I reckon it should be a call-out/banner if possible, just to really deter people :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a bit of text to make it clearer without being verbose. (I hope!)

Vatyx
Vatyx reviewed Sep 14, 2018
View reviewed changes
README.md Outdated
You can [sign up for SpatialOS GDK for Unreal updates](http://go.pardot.com/l/169082/2018-06-15/27ld2t) direct to your mailbox.



Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why so much whitespace here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's gone now.

Vatyx
Vatyx reviewed Sep 14, 2018
View reviewed changes
docs/README.md Show resolved Hide resolved
@ElleEss ElleEss merged commit 983ea3a into master Sep 17, 2018
@girayozil girayozil deleted the docs/UNR568-UNR513 branch October 16, 2018 11:12
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@anne-edwards anne-edwards anne-edwards left review comments

@Vatyx Vatyx Vatyx approved these changes

@danielimprobable danielimprobable Awaiting requested review from danielimprobable

Assignees
No one assigned
Labels
size/XL Denotes a PR that changes 300-599 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ElleEss @Vatyx @anne-edwards @improbable-prow-robot