Skip to content

Commit 4ddc6f3

Browse files
anne-edwardsbradleyjkemp
anne-edwards
authored and
bradleyjkemp
committed
TC-137 Update platform SDK scenario wording (#20)
* First pass at changes * More updates * remove mention of spatiald
1 parent a7c9d9c commit 4ddc6f3

File tree

5 files changed

+48
-48
lines changed

5 files changed

+48
-48
lines changed

‎examples/BYOAuthFlow/Program.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
namespace BYOAuthFlow
1616
{
1717
/// <summary>
18-
/// This contains the implementation of the "integrate your own authentication provider" scenario.
18+
/// This contains the implementation of the "Player authentication" scenario.
1919
/// 1. Start a cloud deployment.
2020
/// 2. Create a PlayerIdentityToken.
2121
/// 3. Choose a deployment that is ready for login.
@@ -25,20 +25,20 @@ namespace BYOAuthFlow
2525
internal class BYOAuthScenario : ScenarioBase
2626
{
2727
/// <summary>
28-
/// PLEASE REPLACE ME.
28+
/// PLEASE REPLACE.
2929
/// Your SpatialOS project name.
30-
/// It should be the same as the name specified in the local spatialos.json file used to start the local API services.
30+
/// It should be the same as the name specified in the local project definition file (spatialos.json) used to start the local API service.
3131
/// </summary>
3232
private const string ProjectName = "platform_sdk_examples";
3333

3434
/// <summary>
35-
/// PLEASE REPLACE ME.
36-
/// The path to a valid launch configuration json file.
35+
/// PLEASE REPLACE.
36+
/// The path to a valid launch configuration JSON file.
3737
/// </summary>
3838
private const string LaunchConfigFilePath = "../blank_project/default_launch.json";
3939

4040
/// <summary>
41-
/// PLEASE REPLACE ME.
41+
/// PLEASE REPLACE.
4242
/// The assembly you want the cloud deployment to use.
4343
/// </summary>
4444
private const string AssemblyId = "blank_project";
@@ -49,7 +49,7 @@ internal class BYOAuthScenario : ScenarioBase
4949
private const string ScenarioWorkerType = "UnityClient";
5050

5151
/// <summary>
52-
/// PlEASE REPLACE ME.
52+
/// PLEASE REPLACE.
5353
/// The name of the deployment.
5454
/// </summary>
5555
private static readonly string DeploymentName = $"byoauth_{StringUtils.Random(6)}";
@@ -66,7 +66,7 @@ internal class BYOAuthScenario : ScenarioBase
6666
private Deployment _deployment;
6767

6868
/// <summary>
69-
/// PLEASE REPLACE ME.
69+
/// PLEASE REPLACE.
7070
/// The SpatialOS refresh token of a service account or a user account.
7171
/// </summary>
7272
private static string RefreshToken =>

‎examples/CapacityLimit/Program.cs‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@ namespace CapacityLimit
1818
internal class CapacityLimitScenario : ScenarioBase
1919
{
2020
/// <summary>
21-
/// PLEASE REPLACE ME.
22-
/// You SpatialOS project name.
23-
/// It should be the same as the name specified in the local `spatialos.json` file used to start the local API service.
21+
/// PLEASE REPLACE.
22+
/// Your SpatialOS project name.
23+
/// It should be the same as the name specified in the local project definition file (spatialos.json) used to start the local API service.
2424
/// </summary>
2525
private const string ProjectName = "platform_sdk_examples";
2626

2727
/// <summary>
28-
/// PLEASE REPLACE ME.
28+
/// PLEASE REPLACE.
2929
/// The assembly you want the cloud deployment to use.
3030
/// </summary>
3131
private const string AssemblyId = "blank_project";
3232

3333
/// <summary>
34-
/// PLEASE REPLACE ME.
34+
/// PLEASE REPLACE.
3535
/// The path to a valid launch configuration JSON file.
3636
/// </summary>
3737
private const string LaunchConfigFilePath = "../blank_project/capacity_launch.json";
@@ -41,7 +41,7 @@ internal class CapacityLimitScenario : ScenarioBase
4141
private const int LocatorServerPort = 443;
4242

4343
/// <summary>
44-
/// PLEASE REPLACE ME.
44+
/// PLEASE REPLACE.
4545
/// The name of the deployment.
4646
/// </summary>
4747
private static readonly string DeploymentName = $"capacity_limited_{StringUtils.Random(6)}";
@@ -58,8 +58,8 @@ internal class CapacityLimitScenario : ScenarioBase
5858
private Deployment _deployment;
5959

6060
/// <summary>
61-
/// PLEASE REPLACE ME.
62-
/// The SpatialOS Platform refresh token for a service account or a user account.
61+
/// PLEASE REPLACE.
62+
/// The SpatialOS refresh token for a service account or a user account.
6363
/// </summary>
6464
private static string RefreshToken =>
6565
Environment.GetEnvironmentVariable("IMPROBABLE_REFRESH_TOKEN") ?? "PLEASE_REPLACE_ME";
@@ -88,7 +88,7 @@ protected override void Setup()
8888
}
8989

9090
/// <summary>
91-
/// This contains the implementation of the capacity limit scenario.
91+
/// This contains the implementation of the "Capacity limiting" scenario.
9292
/// 1. Gets the currently running cloud deployment that has a capacity limit.
9393
/// 2. Tests that connecting more clients than the capacity limit fails.
9494
/// 3. Updates the deployment to increase the capacity limit.

‎examples/GameMaintenance/Program.cs‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,33 +13,33 @@ namespace GameMaintenance
1313
internal class Program
1414
{
1515
/// <summary>
16-
/// PlEASE REPLACE ME.
17-
/// You SpatialOS project name.
18-
/// It should be the same as the name specified in the local spatialos.json file used to start spatiald.
16+
/// PLEASE REPLACE.
17+
/// Your SpatialOS project name.
18+
/// It should be the same as the name specified in the local project definition file (spatialos.json) used to start the local API service.
1919
/// </summary>
2020
private const string ProjectName = "platform_sdk_examples";
2121

2222
/// <summary>
23-
/// PlEASE REPLACE ME.
23+
/// PLEASE REPLACE.
2424
/// The name of the deployment.
2525
/// </summary>
2626
private static readonly string DeploymentName = $"game_maintenance_{StringUtils.Random(6)}";
2727

2828
/// <summary>
29-
/// PlEASE REPLACE ME.
30-
/// The assembly you would want the cloud deployment to use.
29+
/// PLEASE REPLACE.
30+
/// The assembly you want the cloud deployment to use.
3131
/// </summary>
3232
private const string AssemblyId = "blank_project";
3333

3434
/// <summary>
35-
/// PlEASE REPLACE ME.
35+
/// PLEASE REPLACE.
3636
/// The path to a valid snapshot for the target assembly.
3737
/// </summary>
3838
private const string SnapshotFilePath = "../blank_project/snapshots/default.snapshot" ;
3939

4040
/// <summary>
41-
/// PlEASE REPLACE ME.
42-
/// The path to a valid launch configuration json file.
41+
/// PLEASE REPLACE.
42+
/// The path to a valid launch configuration JSON file.
4343
/// </summary>
4444
private const string LaunchConfigFilePath = "../blank_project/default_launch.json";
4545

@@ -53,14 +53,14 @@ internal class Program
5353
SnapshotServiceClient.Create(credentials: CredentialWithProvidedToken);
5454

5555
/// <summary>
56-
/// PlEASE REPLACE ME.
56+
/// PLEASE REPLACE.
5757
/// The SpatialOS Platform refresh token of a service account or a user account.
5858
/// </summary>
5959
private static string RefreshToken =>
6060
Environment.GetEnvironmentVariable("IMPROBABLE_REFRESH_TOKEN") ?? "PLEASE_REPLACE_ME";
6161

6262
/// <summary>
63-
/// This contains the implementation of the game maintenance scenario.
63+
/// This contains the implementation of the "Game maintenance" scenario.
6464
/// 1. Get the currently running cloud deployment that needs taking down for maintenance.
6565
/// 2. Lock down the deployment by removing the `live` tag and setting the worker flag.
6666
/// 3. Take a snapshot of the deployment.

‎examples/ReplicateState/Program.cs‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,33 @@ namespace ReplicateState
1111
internal class Program
1212
{
1313
/// <summary>
14-
/// PlEASE REPLACE ME.
15-
/// You SpatialOS project name.
16-
/// It should be the same as the name specified in the local spaitalos.json file used to start spatiald.
14+
/// PLEASE REPLACE.
15+
/// Your SpatialOS project name.
16+
/// It should be the same as the name specified in the local project definition file (spatialos.json) used to start the local API service.
1717
/// </summary>
1818
private const string ProjectName = "platform_sdk_examples";
1919

2020
/// <summary>
21-
/// PlEASE REPLACE ME.
21+
/// PLEASE REPLACE.
2222
/// The name of the deployment.
2323
/// </summary>
2424
private static readonly string DeploymentName = $"snapshot_upload_{StringUtils.Random(6)}";
2525

2626
/// <summary>
27-
/// PlEASE REPLACE ME.
28-
/// The path to a valid launch configuration json file.
27+
/// PLEASE REPLACE.
28+
/// The path to a valid launch configuration JSON file.
2929
/// </summary>
3030
private const string LaunchConfigFilePath = "../blank_project/default_launch.json";
3131

3232
/// <summary>
33-
/// PlEASE REPLACE ME.
34-
/// The assembly you would want the cloud deployment to use.
33+
/// PLEASE REPLACE.
34+
/// The assembly you want the cloud deployment to use.
3535
/// </summary>
3636
private const string AssemblyId = "blank_project";
3737

3838
/// <summary>
39-
/// PlEASE REPLACE ME.
40-
/// The port spatiald is running on.
39+
/// PLEASE REPLACE.
40+
/// The port that the local API service is running on.
4141
/// </summary>
4242
private const int SpatialDPort = 9876;
4343

@@ -67,14 +67,14 @@ internal class Program
6767
DeploymentServiceClient.Create(SpatialdEndpoint);
6868

6969
/// <summary>
70-
/// PlEASE REPLACE ME.
71-
/// The SpatialOS Platform refresh token of a service account or a user account.
70+
/// PLEASE REPLACE.
71+
/// The SpatialOS refresh token of a service account or a user account.
7272
/// </summary>
7373
private static string RefreshToken =>
7474
Environment.GetEnvironmentVariable("IMPROBABLE_REFRESH_TOKEN") ?? "PLEASE_REPLACE_ME";
7575

7676
/// <summary>
77-
/// This contains the implementation of the "replicate local state to cloud" scenario.
77+
/// This contains the implementation of the "Replicate local state to cloud" scenario.
7878
/// 1. Take a snapshot of a local deployment.
7979
/// 2. Download the local snapshot to a temporary address.
8080
/// 3. Upload the local snapshot to the cloud through in three steps:
@@ -159,15 +159,15 @@ private static void Main(string[] args)
159159
}
160160

161161
/// <summary>
162-
/// This assumes you already have a running spatiald process at the specified port.
163-
/// For more information about how to start a spatiald process, please visit the accompanying documentation on
162+
/// This assumes you already have the local API service ("spatiald") running at the specified port.
163+
/// For more information about how to start the local API service, visit the accompanying documentation on
164164
/// https://docs.improbable.io/reference/latest//platform-sdk/local-api.
165165
/// This starts a local deployment using the blank SpatialOS project included in this repository.
166166
/// </summary>
167167
private static void Setup()
168168
{
169169
Console.WriteLine("Setting up for the scenario");
170-
Console.WriteLine($"Assuming spatiald is running at localhost:{SpatialDPort}");
170+
Console.WriteLine($"Assuming the local API service is running at localhost:{SpatialDPort}");
171171
Console.WriteLine("Starting a local deployment");
172172
var launchConfig = File.ReadAllText(LaunchConfigFilePath);
173173
_localDeployment = LocalDeploymentServiceClient.CreateDeployment(new CreateDeploymentRequest

‎examples/ServiceAccountMaintenance/Program.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ namespace ServiceAccountMaintenance
1111
internal class Program
1212
{
1313
/// <summary>
14-
/// PLEASE REPLACE ME.
14+
/// PLEASE REPLACE.
1515
/// Your SpatialOS project name.
1616
/// This scenario will create a new service account with read and write access to this project.
1717
/// </summary>
@@ -33,7 +33,7 @@ internal class Program
3333
private const int NumberOfServiceAccountsToCreate = 10;
3434

3535
/// <summary>
36-
/// PLEASE REPLACE ME.
36+
/// PLEASE REPLACE.
3737
/// The name given to service accounts created during setup.
3838
/// </summary>
3939
private const string ServiceAccountName = "sa_maintenance_scenario";
@@ -47,15 +47,15 @@ internal class Program
4747
private static List<long> ServiceAccountIds;
4848

4949
/// <summary>
50-
/// PlEASE REPLACE ME.
50+
/// PLEASE REPLACE.
5151
/// The SpatialOS Platform refresh token of a service account or a user account.
5252
/// </summary>
5353
private static string RefreshToken =>
5454
Environment.GetEnvironmentVariable("IMPROBABLE_REFRESH_TOKEN") ?? "PLEASE_REPLACE_ME";
5555

5656

5757
/// <summary>
58-
/// This contains the implementation of the "service account maintenance" scenario.
58+
/// This contains the implementation of the "Service account maintenance" scenario.
5959
/// 1. Iterate over the service accounts in your project.
6060
/// 2. If a service account has expired, or is close to expiry, prolong the expiry time to some point in the
6161
/// future.

0 commit comments

Comments
 (0)