main-rel sync, tutorials publications

.github/workflows/main.yml

@@ -44,7 +44,7 @@ jobs:
           minimum_coverage: 0
 
       # Collect artifacts
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
           name: test-coverage
           path: coverage/

.gitignore

@@ -110,4 +110,7 @@ docs/public/
 .vscode/
 
 # Typedoc generated files
-modules/**/generated/
+modules/**/generated/
+
+# PyCharm
+.idea

gatsby-config.js

@@ -114,6 +114,15 @@ module.exports = {
             },
             __key: 'pages',
         },
+        // Tutorials module
+        {
+            resolve: 'gatsby-source-filesystem',
+            options: {
+                name: 'tutorials',
+                path: `${__dirname}/modules/tutorials/pages`,
+            },
+            __key: 'pages',
+        },
         {
             resolve: 'gatsby-source-filesystem',
             options: {

gatsby-node.js

@@ -26,8 +26,11 @@ exports.createPages = async function ({ actions, graphql }) {
                         parent {
                             ... on File {
                                 name
+                                sourceInstanceName
+                                relativePath
                             }
                         }
+
                     }
                 }
             }
@@ -36,20 +39,66 @@ exports.createPages = async function ({ actions, graphql }) {
 
     const namePageIdMap = {};
     data.allAsciidoc.edges.forEach((e) => {
-        namePageIdMap[e.node.parent.name] =
-            e.node.pageAttributes.pageid || NOT_FOUND_PAGE_ID;
+        const { sourceInstanceName: sourceName, relativePath : relPath } = e.node.parent;
+        const pageId = e.node.pageAttributes.pageid;
+        if (sourceName === 'tutorials'){
+           const relPathSplit = relPath.split('/');
+           const pageIdSplit = pageId.split('_');
+           let finalPageId = pageId;
+           if( pageIdSplit.length > 1) {
+                finalPageId = pageIdSplit[1];
+           }
+           let mapPageId = `tutorials/` + finalPageId;
+           if(relPathSplit.length > 1) {
+                mapPageId = `tutorials/${relPathSplit[0]}/` + finalPageId;
+           }
+           namePageIdMap[e.node.parent.name] =
+                   mapPageId || NOT_FOUND_PAGE_ID;
+        }
+
+        else {
+            namePageIdMap[e.node.parent.name] =
+                e.node.pageAttributes.pageid || NOT_FOUND_PAGE_ID;
+        }
     });
 
     data.allAsciidoc.edges.forEach((edge) => {
         const { pageid: pageId } = edge.node.pageAttributes;
+        const { sourceInstanceName: sourceName, relativePath : relPath } = edge.node.parent;
+
+        // Tutorials module pageids follow pattern {subdirectory}_{final_url_stub} to give unique IDs in system but allow directory structure in URL
+        if (sourceName === 'tutorials'){            
+           // One-level of subdirectory part of stub
+           const relPathSplit = relPath.split('/');
+           const pageIdSplit = pageId.split('_');
+           let finalPageId = pageId;
+           if( pageIdSplit.length > 1) {
+                finalPageId = pageIdSplit[1];
+           }
 
-        actions.createPage({
-            path: `/${pageId}`,
-            component: require.resolve(
-                './src/components/DevDocTemplate/index.tsx',
-            ),
-            context: { pageId, navId: DOC_NAV_PAGE_ID, namePageIdMap },
-        });
+           let finalPath = `/tutorials/${finalPageId}`;
+           if(relPathSplit.length > 1) {
+               finalPath = `/tutorials/${relPathSplit[0]}/${finalPageId}`;
+           }
+
+           actions.createPage({
+                    path: finalPath,
+                    component: require.resolve(
+                        './src/components/DevDocTemplate/index.tsx',
+                    ),
+                    context: { pageId, navId: DOC_NAV_PAGE_ID, namePageIdMap },
+                });
+        }
+
+        else {
+            actions.createPage({
+                path: `/${pageId}`,
+                component: require.resolve(
+                    './src/components/DevDocTemplate/index.tsx',
+                ),
+                context: { pageId, navId: DOC_NAV_PAGE_ID, namePageIdMap },
+            });
+        }
 
         if (pageId === 'introduction') {
             actions.createPage({

jest.config.docs.js

@@ -7,6 +7,7 @@ module.exports = {
         '.+\\.(css|styl|less|sass|scss)$': 'identity-obj-proxy',
         '.+\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
             '<rootDir>/__mocks__/file-mock.js',
+        "^gatsby-page-utils/(.*)$": `gatsby-page-utils/dist/$1`,
     },
     testPathIgnorePatterns: [
         'node_modules',

modules/ROOT/pages/authentication-authorization.adoc

@@ -8,7 +8,7 @@
 
 User access in ThoughtSpot is determined by the privileges assigned to the groups to which they belong. Users and groups are stored locally in ThoughtSpot, even if the users are authenticated using the SAML SSO or trusted authentication method.
 
-To provide access to ThoughtSpot content or define role-based privileges, you need to add users and groups in ThoughtSpot. You can create link:https://cloud-docs.thoughtspot.com/admin/users-groups/add-user.html[user accounts, window=_blank] and link:https://cloud-docs.thoughtspot.com/admin/users-groups/add-group.html[user groups, window=_blank] in the UI or by using xref:api-user-management.adoc[REST APIs].
+To provide access to ThoughtSpot content or define role-based privileges, you need to add users and groups in ThoughtSpot. You can create link:https://docs.thoughtspot.com/cloud/latest/user-management[user accounts, window=_blank] and link:https://docs.thoughtspot.com/cloud/latest/group-management[user groups, window=_blank] in the UI or by using xref:api-user-management.adoc[REST APIs].
 
 == How to synchronize authorization settings from external systems
 

modules/ROOT/pages/catalog-and-audit.adoc

@@ -5,7 +5,7 @@
 :page-pageid: catalog-and-audit
 :page-description: ThoughtSpot REST APIs can be used to audit system configurations and bring metadata into data catalogs
 
-The ThoughtSpot REST API can easily retrieve information about the objects stored on the ThoughtSpot server. The REST API can also retrieve every object in the link:https://cloud-docs.thoughtspot.com/admin/ts-cloud/tml.html[ThoughtSpot Modeling language (TML), window=_blank], which can be parsed as YAML or JSON for additional details.
+The ThoughtSpot REST API can easily retrieve information about the objects stored on the ThoughtSpot server. The REST API can also retrieve every object in the link:https://docs.thoughtspot.com/cloud/latest/tml[ThoughtSpot Modeling language (TML), window=_blank], which can be parsed as YAML or JSON for additional details.
 
 == Map user and group GUIDs to names
 Some API responses only include the GUIDs for other objects, without the string names. If you need the human-readable names of users and groups, use the xref:user-api.adoc#get-user-details[get user details] and the xref:group-api.adoc#get-ug-details [get group details] endpoints. 
@@ -58,7 +58,7 @@ The example link:https://github.com/thoughtspot/ts_rest_api_and_tml_tools/blob/m
 To determine which users belong in a group, use the xref:group-api.adoc#get-users-group[/group/listuser/{groupid}] or xref:group-api.adoc#get-usersInGroup[/group/{groupid}/users] endpoint.
 
 == User privileges
-link:https://cloud-docs.thoughtspot.com/end-user/introduction/about-privileges-end-user.html[Privileges, window=_blank] are capabilities within ThoughtSpot available to a user. Privileges are inherited in an additive manner from groups a user belongs to (privileges are defined on groups only). A user has the full set of privileges from all of their groups on every piece of content the user has sharing access to. 
+link:https://docs.thoughtspot.com/cloud/latest/groups-privileges[Privileges, window=_blank] are capabilities within ThoughtSpot available to a user. Privileges are inherited in an additive manner from groups a user belongs to (privileges are defined on groups only). A user has the full set of privileges from all of their groups on every piece of content the user has sharing access to.
 
 To see a user's privilege set, use the xref:user-api.adoc#get-user-details[user API endpoint]. You can run this API for an  individual user or to get details of all users. In either case, the response object for each user will include a `privileges` array that lists all the privileges the user has.
 

modules/ROOT/pages/common/nav.adoc

@@ -27,6 +27,25 @@
 *** link:{{navprefix}}/graphql-playground[GraphQL Playground]
 *** link:{{navprefix}}/rest-playground[REST API Playground]
 
+* link:{{navprefix}}/tutorials/tutorials-overview[Tutorials]
+** link:{{navprefix}}/tutorials/tse-fundamentals/intro[Embedding Fundamentals]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-01[01 - Overview]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-02[02 - Set up for course]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-03[03 - Security setup]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-04[04 - Start coding]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-05[05 - Embed Search]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-06[06 - Embed Natural Language Search]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-07[07 - Embed Liveboard]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-08[08 - Embed Visualization]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-09[09 - Embed full application]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-10[10 - Style embedded app]
+*** link:{{navprefix}}/tutorials/tse-fundamentals/lesson-11[11 - Course summary]
+** link:{{navprefix}}/tutorials/rest-api/intro[REST API]
+*** link:{{navprefix}}/tutorials/rest-api/lesson-01[01 - REST API overview]
+*** link:{{navprefix}}/tutorials/rest-api/lesson-02[02 - Simple Python implementation]
+*** link:{{navprefix}}/tutorials/rest-api/lesson-03[03 - Complex REST API workflows]
+*** link:{{navprefix}}/tutorials/rest-api/lesson-04[04 - Browser JavaScript REST API implementation]
+
 * link:{{navprefix}}/getting-started[Embed ThoughtSpot]
 ** link:{{navprefix}}/getting-started[Quickstart Guide]
 ** link:{{navprefix}}/tsembed[Embed a ThoughtSpot component]

modules/ROOT/pages/connections.adoc

@@ -261,7 +261,7 @@ __String__. ID of the project associated with your BigQuery account.
 
 * `oauth_pvt_key`
 +
-__String__. The secret key obtained for your BigQuery service account. To obtain the secret key, you must create a custom role in BigQuery and set up your service account. For more information, see link:https://cloud-docs.thoughtspot.com/admin/ts-cloud/ts-cloud-embrace-gbq-prerequisites.html#custom-role[BigQuery prerequisites, window=_blank].
+__String__. The secret key obtained for your BigQuery service account. To obtain the secret key, you must create a custom role in BigQuery and set up your service account. For more information, see link:https://docs.thoughtspot.com/cloud/latest/connections-gbq-prerequisites[BigQuery prerequisites, window=_blank].
 
 To set up a *BigQuery connection with OAuth*, see https://docs.thoughtspot.com/cloud/latest/connections-gbq-oauth[Configure OAuth for a Google BigQuery connection, window=_blank].
 ////

modules/ROOT/pages/customize-text-strings.adoc

@@ -53,7 +53,7 @@ customizations: {
 ----
 +
 
-However, if the `Pin to Livebaord` string precedes the `"Liveboard": "Dashboard"` string, specify the substring as `Pin to Livebaord` as shown in this example.
+However, if the `Pin to Liveboard` string precedes the `"Liveboard": "Dashboard"` string, specify the substring as `Pin to Livebaord` as shown in this example.
 +
 [source,JavaScript]
 ----

modules/ROOT/pages/data-report-v2-api.adoc

@@ -41,7 +41,6 @@ Send an API request to the `/api/rest/2.0/metadata/search` endpoint with the fol
 ----
 
 +
-
 If you don't know the exact name of the data source object, specify the metadata `type` as `LOGICAL_TABLE` in your API request, and then copy the GUID of the data object from the API response.
 
 Find the GUID of the data object via UI::
@@ -53,22 +52,22 @@ If you are using the new experience, click the Application switcher image:./imag
 ----
 https://<your-thoughtspot-instance>/#/data/tables/
 ----
-
++
 . On the **Data** > **Home** page, select the data object. For example, if the data source object is a Worksheet, click **Worksheets** and then open the Worksheet.
 . In the address bar of the web browser, note the GUID of the data source object.  For example, in the following address string, the GUID is `9d93a6b8-ca3a-4146-a1a1-e908b71b963f`:
-
 +
 ----
 https://<your-thoughtspot-instance>/#/data/tables/9d93a6b8-ca3a-4146-a1a1-e908b71b963f
 ----
+
 . Copy the GUID.
 
 ==== Search query
 
 include::{path}/search-query-string.adoc[]
 
 .**Example**
-[source,JSON]
+[source,cURL]
 ----
 curl -X POST \
   --url 'https://{ThoughtSpot-Host}/api/rest/2.0/searchdata' \
@@ -87,7 +86,7 @@ To get data from a Liveboard object and its visualizations via `POST /api/rest/2
 The API request body must include the name or GUID of the Liveboard to fetch data. To get specific visualizations from a given Liveboard, add the names or GUIDs of the visualizations in the  `visualization_identifiers` array.
 
 .**Example**
-[source,JSON]
+[source,cURL]
 ----
 curl -X POST \
   --url 'https://{ThoughtSpot-Host}/api/rest/2.0/metadata/liveboard/data' \
@@ -169,7 +168,7 @@ To get data from a saved Answer object via `/api/rest/2.0/metadata/answer/data`,
 The API request body must include the name or GUID of the saved Answer.
 
 .**Example**
-[source,JSON]
+[source,cURL]
 ----
 curl -X POST \
   --url 'https://{ThoughtSpot-Host}/api/rest/2.0/metadata/answer/data' \

modules/ROOT/pages/deploy-with-tml-apis.adoc

@@ -6,7 +6,7 @@
 :page-pageid: deploy-with-tml-apis
 :page-description: Development and deployment following the SDLC practices can be achieved using TML and REST API
 
-When deploying embedded analytics, each organization will have defined practices for development, testing, and deployment of content to ThoughtSpot. ThoughtSpot instances act as a constantly running service, so deployment only involves publishing *ThoughtSpot content*, in the form of link:https://cloud-docs.thoughtspot.com/admin/ts-cloud/tml.html[ThoughtSpot Modeling Language (TML), window=_blank] files to a given ThoughtSpot instance.
+When deploying embedded analytics, each organization will have defined practices for development, testing, and deployment of content to ThoughtSpot. ThoughtSpot instances act as a constantly running service, so deployment only involves publishing *ThoughtSpot content*, in the form of link:https://docs.thoughtspot.com/cloud/latest/tml[ThoughtSpot Modeling Language (TML), window=_blank] files to a given ThoughtSpot instance.
 
 ThoughtSpot has xref:version_control.adoc[Git integration] designed to automate most of the steps involved in the following process. Please see if the xref:version_control.adoc[Git integration capabilities] will work for your needs before building a process with the TML APIs directly.
 

modules/ROOT/pages/development-and-deployment.adoc

@@ -10,7 +10,7 @@ When deploying embedded analytics, each organization will have defined practices
 
 ThoughtSpot instances act as a constantly running service, so xref:development-and-deployment.adoc#deploy-between-environments[deployment] only involves *ThoughtSpot data models and content*.
 
-ThoughtSpot provides numerous tools for building a structured deployment process, built around the link:https://cloud-docs.thoughtspot.com/admin/ts-cloud/tml.html[ThoughtSpot Modeling Language (TML), window=_blank] format for representing the xref:intro-thoughtspot-objects.adoc[objects within ThoughtSpot].
+ThoughtSpot provides numerous tools for building a structured deployment process, built around the link:https://docs.thoughtspot.com/cloud/latest/tml[ThoughtSpot Modeling Language (TML), window=_blank] format for representing the xref:intro-thoughtspot-objects.adoc[objects within ThoughtSpot].
 
 == Best practices
 The primary tool for structured development and deployment in ThoughtSpot is called xref:orgs.adoc[Orgs]