From 8433a027ad37eb5d9287030153b23ffec1002c31 Mon Sep 17 00:00:00 2001 From: vchske Date: Wed, 5 Oct 2022 17:35:03 -0700 Subject: [PATCH] Text changes for API rebranding (#1330) * Text changes for API rebranding * Text changes and bug fixes for API rebranding * Format updates --- .../selfserve_selfserveutils.bladetype.html | 513 ++++++++++-------- src/Common/CollapsedResourceTree.tsx | 4 +- src/Common/ResourceTreeContainer.tsx | 3 +- .../Tutorials/MongoQuickstartTutorial.tsx | 2 +- src/Explorer/SplashScreen/SplashScreen.tsx | 22 +- src/SelfServe/SelfServeUtils.tsx | 10 +- src/Utils/APITypeUtils.ts | 17 + 7 files changed, 314 insertions(+), 257 deletions(-) diff --git a/docs/enums/selfserve_selfserveutils.bladetype.html b/docs/enums/selfserve_selfserveutils.bladetype.html index 9283b498f..1ba5d2e0d 100644 --- a/docs/enums/selfserve_selfserveutils.bladetype.html +++ b/docs/enums/selfserve_selfserveutils.bladetype.html @@ -1,5 +1,6 @@ + @@ -9,256 +10,292 @@ + -
-
-
-
- -
-
- Options -
-
- All -
    -
  • Public
    • -
  • Public/Protected
    • -
  • All
    • -
-
- - - - +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu
- Menu
-
-
-
- -

Enumeration BladeType

+
+
+ +

Enumeration BladeType

+
-
-
-
-
-
-
-
-
-

Portal Blade types

+ +
+
+
+
+
+
+

Portal Blade types

+
-
-
-
-

Index

-
-
-
-

Enumeration members

-
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

CassandraKeys

+
CassandraKeys: = + "cassandraDbKeys"
+ +
+
+

Keys blade of a Azure Cosmos DB for Apache Cassandra account.

+
+
+
+
+ +

GremlinKeys

+
GremlinKeys: = + "keys"
+ +
+
+

Keys blade of a Azure Cosmos DB for Apache Gremlin account.

+
+
+
+
+ +

Metrics

+
Metrics: + = "metrics"
+ +
+
+

Metrics blade of an Azure Cosmos DB account.

+
+
+
+
+ +

MongoKeys

+
MongoKeys: = + "mongoDbKeys"
+ +
+
+

Keys blade of a Azure Cosmos DB for MongoDB account.

+
+
+
+
+ +

SqlKeys

+
SqlKeys: + = "keys"
+ +
+
+

Keys blade of a Azure Cosmos DB for NoSQL account.

+
+
+
+
+ +

TableKeys

+
TableKeys: = + "tableKeys"
+ +
+
+

Keys blade of a Azure Cosmos DB for Table account.

+
+
+
+
+
+
+ +
-
- - -
-

Enumeration members

-
- -

CassandraKeys

-
CassandraKeys: = "cassandraDbKeys"
- -
-
-

Keys blade of a Cassandra API account.

-
-
-
-
- -

GremlinKeys

-
GremlinKeys: = "keys"
- -
-
-

Keys blade of a Gremlin API account.

-
-
-
-
- -

Metrics

-
Metrics: = "metrics"
- -
-
-

Metrics blade of an Azure Cosmos DB account.

-
-
-
-
- -

MongoKeys

-
MongoKeys: = "mongoDbKeys"
- -
-
-

Keys blade of a Mongo API account.

-
-
-
-
- -

SqlKeys

-
SqlKeys: = "keys"
- -
-
-

Keys blade of a SQL API account.

-
-
-
-
- -

TableKeys

-
TableKeys: = "tableKeys"
- -
-
-

Keys blade of a Table API account.

-
-
-
-
-
-
- - + + + + +
- - -
-

Generated using TypeDoc

-
-
- +
+ + \ No newline at end of file diff --git a/src/Common/CollapsedResourceTree.tsx b/src/Common/CollapsedResourceTree.tsx index 9a9e1661d..791bdfe7f 100644 --- a/src/Common/CollapsedResourceTree.tsx +++ b/src/Common/CollapsedResourceTree.tsx @@ -1,6 +1,6 @@ import React, { FunctionComponent, MutableRefObject, useEffect, useRef } from "react"; import arrowLeftImg from "../../images/imgarrowlefticon.svg"; -import { userContext } from "../UserContext"; +import { getApiShortDisplayName } from "../Utils/APITypeUtils"; import { NormalizedEventKey } from "./Constants"; export interface CollapsedResourceTreeProps { @@ -45,7 +45,7 @@ export const CollapsedResourceTree: FunctionComponent - {userContext.apiType} API + {getApiShortDisplayName()} diff --git a/src/Common/ResourceTreeContainer.tsx b/src/Common/ResourceTreeContainer.tsx index 00693a2c0..b13d79bac 100644 --- a/src/Common/ResourceTreeContainer.tsx +++ b/src/Common/ResourceTreeContainer.tsx @@ -6,6 +6,7 @@ import Explorer from "../Explorer/Explorer"; import { ResourceTokenTree } from "../Explorer/Tree/ResourceTokenTree"; import { ResourceTree } from "../Explorer/Tree/ResourceTree"; import { userContext } from "../UserContext"; +import { getApiShortDisplayName } from "../Utils/APITypeUtils"; import { NormalizedEventKey } from "./Constants"; export interface ResourceTreeContainerProps { @@ -42,7 +43,7 @@ export const ResourceTreeContainer: FunctionComponent
- {userContext.apiType} API + {getApiShortDisplayName()}
{ onDismiss={() => onDimissTeachingBubble()} footerContent="Step 4 of 8" > - Query your data using the filter function. Azure Cosmos DB API for MongoDB provides comprehensive support for + Query your data using the filter function. Azure Cosmos DB for MongoDB provides comprehensive support for MongoDB query language constructs. You can also use your favorite MongoDB tools and drivers to do so. ); diff --git a/src/Explorer/SplashScreen/SplashScreen.tsx b/src/Explorer/SplashScreen/SplashScreen.tsx index b9c1286b2..db034914d 100644 --- a/src/Explorer/SplashScreen/SplashScreen.tsx +++ b/src/Explorer/SplashScreen/SplashScreen.tsx @@ -117,7 +117,9 @@ export class SplashScreen extends React.Component {
- {userContext.apiType === "Postgres" ? "Welcome to Cosmos DB - PostgreSQL" : "Welcome to Cosmos DB"} + {userContext.apiType === "Postgres" + ? "Welcome to Azure Cosmos DB for PostgreSQL" + : "Welcome to Azure Cosmos DB"}
@@ -348,8 +350,8 @@ export class SplashScreen extends React.Component { title: userContext.apiType === "Postgres" ? "Connect with PG Admin" : "Connect", description: userContext.apiType === "Postgres" - ? "Prefer using your own choice of tooling? Find the connection string you need to connect" - : "Prefer PGadmin? Find your connection strings here", + ? "Prefer PGadmin? Find your connection strings here" + : "Prefer using your own choice of tooling? Find the connection string you need to connect", onClick: () => useTabs.getState().openAndActivateReactTab(ReactTabKind.Connect), }; heroes.push(connectBtn); @@ -433,7 +435,7 @@ export class SplashScreen extends React.Component { { link: "https://aka.ms/mongodbintro", title: "What is the MongoDB API?", - description: "Understand the Cosmos DB API for MongoDB and its features.", + description: "Understand Azure Cosmos DB for MongoDB and its features.", }, { link: "https://aka.ms/mongodbfeaturesupport", @@ -490,7 +492,7 @@ export class SplashScreen extends React.Component { { link: "https://aka.ms/tableintro", title: "What is the Table API?", - description: "Understand the Table API in Cosmos DB and its features", + description: "Understand Azure Cosmos DB for Table and its features", }, { link: "https://aka.ms/tableimport", @@ -499,8 +501,8 @@ export class SplashScreen extends React.Component { }, { link: "https://aka.ms/tablefaq", - title: "Table API FAQs", - description: "Common questions about the Table API", + title: "Azure Cosmos DB for Table FAQs", + description: "Common questions about Azure Cosmos DB for Table", }, ]; break; @@ -637,17 +639,17 @@ export class SplashScreen extends React.Component { { link: "https://aka.ms/tabledotnet", title: "Build a .NET App", - description: "How to access Table API from a .NET app.", + description: "How to access Azure Cosmos DB for Table from a .NET app.", }, { link: "https://aka.ms/Tablejava", title: "Build a Java App", - description: "Create a Table API app with Java SDK ", + description: "Create a Azure Cosmos DB for Table app with Java SDK ", }, { link: "https://aka.ms/tablenodejs", title: "Build a Node.js App", - description: "Create a Table API app with Node.js SDK", + description: "Create a Azure Cosmos DB for Table app with Node.js SDK", }, ]; break; diff --git a/src/SelfServe/SelfServeUtils.tsx b/src/SelfServe/SelfServeUtils.tsx index 87e66f6c8..9c24db6e0 100644 --- a/src/SelfServe/SelfServeUtils.tsx +++ b/src/SelfServe/SelfServeUtils.tsx @@ -40,23 +40,23 @@ export enum SelfServeType { */ export enum BladeType { /** - * Keys blade of a SQL API account. + * Keys blade of a Azure Cosmos DB for NoSQL account. */ SqlKeys = "keys", /** - * Keys blade of a Mongo API account. + * Keys blade of a Azure Cosmos DB for MongoDB account. */ MongoKeys = "mongoDbKeys", /** - * Keys blade of a Cassandra API account. + * Keys blade of a Azure Cosmos DB for Apache Cassandra account. */ CassandraKeys = "cassandraDbKeys", /** - * Keys blade of a Gremlin API account. + * Keys blade of a Azure Cosmos DB for Apache Gremlin account. */ GremlinKeys = "keys", /** - * Keys blade of a Table API account. + * Keys blade of a Azure Cosmos DB for Table account. */ TableKeys = "tableKeys", /** diff --git a/src/Utils/APITypeUtils.ts b/src/Utils/APITypeUtils.ts index 83e2a1842..0a7e8f9d1 100644 --- a/src/Utils/APITypeUtils.ts +++ b/src/Utils/APITypeUtils.ts @@ -57,3 +57,20 @@ export const getUploadName = (): string => { return "Items"; } }; + +export const getApiShortDisplayName = (): string => { + switch (userContext.apiType) { + case "Cassandra": + return "Apache Cassandra API"; + case "Gremlin": + return "Apache Gremlin API"; + case "Mongo": + return "MongoDB API"; + case "Postgres": + return "PostgreSQL API"; + case "SQL": + return "NoSQL API"; + case "Tables": + return "Table API"; + } +};