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

DOC-1255 Clarify elements of the GDK in readme #1287

Merged
merged 4 commits into from
Aug 9, 2019

Conversation

anne-edwards
Copy link
Contributor

@anne-edwards anne-edwards commented Aug 8, 2019

Contributions: We are not currently taking public contributions - see our contributions policy. However, we are accepting issues and we do want your feedback.


Description

Updated the readme to clarify what the GDK is (i.e. not just a plugin), and clarify what's in this repo vs. other repos.

Primary reviewers

@ElleEss @ernopp

@improbable-prow-robot improbable-prow-robot added jira/no-ticket Indicates a PR has no corresponding JIRA ticket size/S Denotes a PR that changes 15-39 lines, ignoring generated files. labels Aug 8, 2019
@anne-edwards anne-edwards changed the title Clarify elements of the GDK DOC-1255 Clarify elements of the GDK in readme Aug 8, 2019
@improbable-prow-robot
Copy link

Corresponding JIRA ticket: https://improbableio.atlassian.net/browse/DOC-1255

@improbable-prow-robot improbable-prow-robot added jira/DOC and removed jira/no-ticket Indicates a PR has no corresponding JIRA ticket labels Aug 8, 2019
Copy link
Contributor

@ElleEss ElleEss left a comment

Choose a reason for hiding this comment

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

Few teeny suggestions.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ElleEss ElleEss left a comment

Choose a reason for hiding this comment

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

Few teeny suggestions.

README.md Show resolved Hide resolved
anne-edwards and others added 3 commits August 9, 2019 10:13
Co-Authored-By: Laura <36853437+ElleEss@users.noreply.github.com>
@anne-edwards anne-edwards merged commit d0984cf into 0.6.1-hotfix Aug 9, 2019
@anne-edwards anne-edwards deleted the docs/update-readme branch August 9, 2019 09:36
oblm added a commit that referenced this pull request Aug 15, 2019
* UNR-1857  Unresolved RPC parameters can cause permanent queue blocking (#1277)

* Apply RPC with unresolved refs after it's been queued for a while. 

* Updated Changelog.md

* Moved logic to process RPCs with unresolved references to ApplyRPC function. Added SecondsToProcessRPCWithUnresolvedRefs setting with 1.0 as default value

* Update SpatialGDK/Source/SpatialGDK/Public/Utils/RPCContainer.h

Co-Authored-By: improbable-valentyn <32096431+improbable-valentyn@users.noreply.github.com>

* Added logging for RPCs processed with unresolved parameters.

* Updated CHANGELOG.md

* Updated CHANGELOG.md

* Fixed a couple of typos

* Update SpatialGDK/Source/SpatialGDK/Public/SpatialGDKSettings.h

Co-Authored-By: Michael Samiec <michaelsamiec@improbable.io>

* Changed SecondsToProcessRPCWithUnresolvedRefs to WaitTimeBeforeProcessingReceivedRPCWithUnresolveRefs, exposed it GDK settings.

* Fixed UI issue for a new setting

* Update CHANGELOG.md

Co-Authored-By: Michael Samiec <michaelsamiec@improbable.io>

* Renamed Timestamp -> QueuedTimestamp

* Renamed WaitTimeBeforeProcessingReceivedRPC_WithUnresolvedRefs -> QueuedIncomingRPCWaitTime, but kept the same DisplayName

* Update CHANGELOG.md

* IsListening and ownership fix (#1246) (#1284)

* Initial commit

* Cleaned outdated code

* Iterate through an Actor's children when its ownership changes.

* Update SpatialActorChannel.h

* Update SpatialActorChannel.cpp

* Changed Schema_GetBool -> GetBoolFromSchema

* Update SpatialGDK/Source/SpatialGDK/Public/Schema/ServerRPCEndpoint.h

Co-Authored-By: Michael Samiec <michaelsamiec@improbable.io>

* Use 0 NetGuid for Actors that are not replicated

* UNR-1864 Use GetPlugin helper method to resolve sim player laun… (#1278)

* Used GetPlugin helper method to resolve sim player launch config

* Updated changelog

* DOC-1255 Clarify elements of the GDK in readme (#1287)

* Clarify elements of the GDK

* Apply suggestions from code review

Co-Authored-By: Laura <36853437+ElleEss@users.noreply.github.com>

* Updates from review

* Update CHANGELOG.md

* Switch validity checks to use whats defaulted (#1300)

* Update CHANGELOG.md

* Update CHANGELOG.md
aleximprobable added a commit that referenced this pull request Aug 19, 2019
* UNR-1857  Unresolved RPC parameters can cause permanent queue blocking (#1277)

* Apply RPC with unresolved refs after it's been queued for a while. 

* Updated Changelog.md

* Moved logic to process RPCs with unresolved references to ApplyRPC function. Added SecondsToProcessRPCWithUnresolvedRefs setting with 1.0 as default value

* Update SpatialGDK/Source/SpatialGDK/Public/Utils/RPCContainer.h

Co-Authored-By: improbable-valentyn <32096431+improbable-valentyn@users.noreply.github.com>

* Added logging for RPCs processed with unresolved parameters.

* Updated CHANGELOG.md

* Updated CHANGELOG.md

* Fixed a couple of typos

* Update SpatialGDK/Source/SpatialGDK/Public/SpatialGDKSettings.h

Co-Authored-By: Michael Samiec <michaelsamiec@improbable.io>

* Changed SecondsToProcessRPCWithUnresolvedRefs to WaitTimeBeforeProcessingReceivedRPCWithUnresolveRefs, exposed it GDK settings.

* Fixed UI issue for a new setting

* Update CHANGELOG.md

Co-Authored-By: Michael Samiec <michaelsamiec@improbable.io>

* Renamed Timestamp -> QueuedTimestamp

* Renamed WaitTimeBeforeProcessingReceivedRPC_WithUnresolvedRefs -> QueuedIncomingRPCWaitTime, but kept the same DisplayName

* Update CHANGELOG.md

* IsListening and ownership fix (#1246) (#1284)

* Initial commit

* Cleaned outdated code

* Iterate through an Actor's children when its ownership changes.

* Update SpatialActorChannel.h

* Update SpatialActorChannel.cpp

* Changed Schema_GetBool -> GetBoolFromSchema

* Update SpatialGDK/Source/SpatialGDK/Public/Schema/ServerRPCEndpoint.h

Co-Authored-By: Michael Samiec <michaelsamiec@improbable.io>

* Use 0 NetGuid for Actors that are not replicated

* UNR-1864 Use GetPlugin helper method to resolve sim player laun… (#1278)

* Used GetPlugin helper method to resolve sim player launch config

* Updated changelog

* DOC-1255 Clarify elements of the GDK in readme (#1287)

* Clarify elements of the GDK

* Apply suggestions from code review

Co-Authored-By: Laura <36853437+ElleEss@users.noreply.github.com>

* Updates from review

* Update CHANGELOG.md

* Switch validity checks to use whats defaulted (#1300)

* Update CHANGELOG.md

* Update CHANGELOG.md
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
jira/DOC size/S Denotes a PR that changes 15-39 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants