From 181a7af3f8554c9cc9b89320d3f5c9717f9097e9 Mon Sep 17 00:00:00 2001 From: Jay <17855766+playaj@users.noreply.github.com> Date: Mon, 15 Apr 2024 06:20:19 -0700 Subject: [PATCH 1/3] Create README.md It's time to add a README. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..be031f6ab --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +h1. About this repository + +h2. Codebase +The Vantage, VantageCloudLakeUseCases, and _ folders are the core of the In Product Help in Teradata's Vantage Cloud Lake UI. +The contents of the Vantage folder is json, markdown, and image files transformed from LwDITA topics and ditamaps. The Vantage folder also has localized versions of the English source in es-es, zh_cn, fr_fr, de_de, ja-jp. +Several folders such as AnalyticFunctions are inactive for years, and can be archived or removed. + +h2. Branches, PRs, Tags +The codebase does not currently use release labels or tags. +The tree uses the master branch, and content-based updates replace what was last committed and pushed. +Otherwise, no branching is currently used specifically or only for the help content in this repo. +Proposed code changes in configurations, such as to the workflow automation, use PRs. + +h2. Looking Ahead +Future UX integrations of the help expeience may include or implement [docs observability](https://passo.uno/docs-observability-do11y/). +Observable docs has content that can be instrumented with session tracking, analytics, deep linking, and other means to measure how truly effective content meshes with positive user outcomes. From 561671d1ce50edf323d0a922b8b2bb91a4fd79f2 Mon Sep 17 00:00:00 2001 From: Jay <17855766+playaj@users.noreply.github.com> Date: Mon, 15 Apr 2024 06:29:09 -0700 Subject: [PATCH 2/3] Update README.md used correct md syntax --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index be031f6ab..48e08bfd3 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -h1. About this repository +## About this repository -h2. Codebase +### Codebase The Vantage, VantageCloudLakeUseCases, and _ folders are the core of the In Product Help in Teradata's Vantage Cloud Lake UI. The contents of the Vantage folder is json, markdown, and image files transformed from LwDITA topics and ditamaps. The Vantage folder also has localized versions of the English source in es-es, zh_cn, fr_fr, de_de, ja-jp. Several folders such as AnalyticFunctions are inactive for years, and can be archived or removed. -h2. Branches, PRs, Tags +### Branches, PRs, Tags The codebase does not currently use release labels or tags. The tree uses the master branch, and content-based updates replace what was last committed and pushed. Otherwise, no branching is currently used specifically or only for the help content in this repo. Proposed code changes in configurations, such as to the workflow automation, use PRs. -h2. Looking Ahead +### Looking Ahead Future UX integrations of the help expeience may include or implement [docs observability](https://passo.uno/docs-observability-do11y/). Observable docs has content that can be instrumented with session tracking, analytics, deep linking, and other means to measure how truly effective content meshes with positive user outcomes. From 8aa1d504938639d1be6a52fe950270eec37bfc0f Mon Sep 17 00:00:00 2001 From: Rick Sapir <61597346+fs250044@users.noreply.github.com> Date: Mon, 15 Apr 2024 09:39:23 -0400 Subject: [PATCH 3/3] Update README.md Minor updates & fixes. Added (C) notice --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 48e08bfd3..e7d9cd6fa 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ ## About this repository ### Codebase -The Vantage, VantageCloudLakeUseCases, and _ folders are the core of the In Product Help in Teradata's Vantage Cloud Lake UI. +The Vantage, VantageCloudLakeUseCases, and _ folders are the core of the in-product help (IPH) in Teradata VantageCloud Lake console. The contents of the Vantage folder is json, markdown, and image files transformed from LwDITA topics and ditamaps. The Vantage folder also has localized versions of the English source in es-es, zh_cn, fr_fr, de_de, ja-jp. -Several folders such as AnalyticFunctions are inactive for years, and can be archived or removed. ### Branches, PRs, Tags The codebase does not currently use release labels or tags. @@ -14,3 +13,6 @@ Proposed code changes in configurations, such as to the workflow automation, use ### Looking Ahead Future UX integrations of the help expeience may include or implement [docs observability](https://passo.uno/docs-observability-do11y/). Observable docs has content that can be instrumented with session tracking, analytics, deep linking, and other means to measure how truly effective content meshes with positive user outcomes. + +--- +Copyright © by Teradata. All Rights Reserved. https://www.teradata.com/