Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create README.md #70

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Create README.md #70

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
181a7af
Create README.md
playaj Apr 15, 2024
561671d
Update README.md
playaj Apr 15, 2024
8aa1d50
Update README.md
fs250044 Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## About this repository

### Codebase
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.

### 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.

### 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/