Skip to content

Commit 8592cf7

Browse files
committed
Documentation Rebuild
1 parent d94de27 commit 8592cf7

File tree

271 files changed

+26657
-5560
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

271 files changed

+26657
-5560
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Deploy Documentation to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- Feb2026
8+
paths:
9+
- 'docs/**'
10+
- '.github/workflows/deploy-docs.yml'
11+
- 'CHANGELOG.md'
12+
workflow_dispatch:
13+
14+
permissions:
15+
contents: read
16+
pages: write
17+
id-token: write
18+
19+
concurrency:
20+
group: pages
21+
cancel-in-progress: false
22+
23+
jobs:
24+
build:
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout repository
28+
uses: actions/checkout@v4
29+
30+
- name: Setup Node.js
31+
uses: actions/setup-node@v4
32+
with:
33+
node-version: '20'
34+
cache: 'npm'
35+
cache-dependency-path: 'docs/package-lock.json'
36+
37+
- name: Install dependencies
38+
run: cd docs && npm ci
39+
40+
- name: Build documentation
41+
run: cd docs && npm run docs:build
42+
43+
- name: Configure Pages
44+
uses: actions/configure-pages@v4
45+
46+
- name: Upload artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: docs/.vitepress/dist
50+
51+
deploy:
52+
runs-on: ubuntu-latest
53+
needs: build
54+
steps:
55+
- name: Deploy to GitHub Pages
56+
id: deployment
57+
uses: actions/deploy-pages@v4

CHANGELOG.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
"New MCP server troubleshooting guide (mcp-server/TROUBLESHOOTING.md) with common issues and solutions",
1616
"Improved error messages and debugging capabilities throughout the codebase",
1717
"CLI Startup Performance Optimization - Implemented lazy-loading strategy for command modules and dependencies, resulting in 60-77% faster startup times for most commands. Key improvements: ultra-fast path for --version flag bypassing all heavy module imports, deferred yargs loading until after fast-path checks, conditional debug module loading only when DEBUG environment variable is set, elimination of completion overhead, and simplified validation logic. Average command execution now starts in ~700ms vs previous ~2,200ms.",
18-
"New import command features - added support for matching columns by order, name, or auto (try name then fall back to order), improved error handling and reporting for mismatched columns and data type issues, and added support for additional data types in the import process"
18+
"New import command features - added support for matching columns by order, name, or auto (try name then fall back to order), improved error handling and reporting for mismatched columns and data type issues, and added support for additional data types in the import process",
19+
"Completely new documentation website build on VitePress with improved navigation, search, and user experience. The new documentation site is built with VitePress and features a modern design, better organization, and enhanced content including more examples and troubleshooting guides. The documentation is now also available in German for key sections."
1920
]
2021
},
2122
{

CHANGELOG.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
2222
- Improved error messages and debugging capabilities throughout the codebase
2323
- CLI Startup Performance Optimization - Implemented lazy-loading strategy for command modules and dependencies, resulting in 60-77% faster startup times for most commands. Key improvements: ultra-fast path for --version flag bypassing all heavy module imports, deferred yargs loading until after fast-path checks, conditional debug module loading only when DEBUG environment variable is set, elimination of completion overhead, and simplified validation logic. Average command execution now starts in ~700ms vs previous ~2,200ms.
2424
- New import command features - added support for matching columns by order, name, or auto (try name then fall back to order), improved error handling and reporting for mismatched columns and data type issues, and added support for additional data types in the import process
25+
- Completely new documentation website build on VitePress with improved navigation, search, and user experience. The new documentation site is built with VitePress and features a modern design, better organization, and enhanced content including more examples and troubleshooting guides. The documentation is now also available in German for key sections.
2526

2627
## [3.202601.0] - 2026-01-30
2728

@@ -436,7 +437,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
436437
- Add node.js engines version check on startup and output a warning if there is a mismatch based upon the engines specification in package.json
437438
- Add busy indicator in browser based UI
438439
- massConvert to HDBTABLE or HDBMIGRATIONTABLE with the useCatalogPure option now removes CS_* Types from the output for compatibility with target SAP HANA Cloud systems
439-
- massConvert to HDBTABLE or HDBMIGRATIONTABLE without the useCatalogPure option also includes associations now. However when coming from HDBCDS based sources the column names contain dots which are incompatible with CAP CDS. The associations will still have the old column names while the rest of the table defition must replace the dot with underscore or recieve CDS Compiler errors. I will leave this functionality in place, although imperfect. If you have associations in your source system, strongly consider using the useCatalogPure option instead.
440+
- massConvert to HDBTABLE or HDBMIGRATIONTABLE without the useCatalogPure option also includes associations now. However when coming from HDBCDS based sources the column names contain dots which are incompatible with CAP CDS. The associations will still have the old column names while the rest of the table defition must replace the dot with underscore or recieve CDS Compiler errors. I will leave this functionality in place, although imperfect. If you have associations in your source system, strongly consider using the useCatalogPure option instead.
440441
- Added new commands featuresUI, featureUsageUI, functionsUI, hdiUI, sbssUI, schemaInstancesUI, schemaInstancesUI, securestoreUI, and upsUI
441442

442443
## [2.202107.4] - 2021-07-27
@@ -487,7 +488,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
487488

488489
**Changed**
489490

490-
- Merge [mass rename](https://gist.github.com/ThePlenkov/2fc31e05a43a4ec395c9a4d8f6c8276a#gistcomment-3759807) from [@ThePlenkov](https://github.com/ThePlenkov)
491+
- Merge [mass rename](https://gist.github.com/ThePlenkov/2fc31e05a43a4ec395c9a4d8f6c8276a#gistcomment-3759807) from [@ThePlenkov](https://github.com/ThePlenkov)
491492
- Fix [Issue with connecting to XS Advance Database #53](https://github.com/SAP-samples/hana-developer-cli-tool-example/issues/53)
492493
- Remove warning during HDI deploy from db module created with createModule due to reference to afllangprocedure in the generated .hdiconfig
493494

@@ -567,7 +568,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
567568
- New parameter --quiet that disables extra output and human readable formatting for when you want to script commands and get pure results output
568569
- New parameter --debug - for troubleshooting of the hana-cli tool itself. It will produce a LOT of detailed output. Nice if you are curious what queries are being sent to SAP to fullfill a command
569570
- Options in the help are now grouped by Conneciton Parameters, Troubleshooting, and Options
570-
- New order of processing for making connections as follows:
571+
- New order of processing for making connections as follows:
571572
- First we look for the Admin option and use a default-env-admin.json - this overrides all other parameters
572573
- If no admin option or if there was an admin option but no default-env-admin.json could be found in this directory or 5 parent directories then look for a .env file in this directory or up to 5 parent directories
573574
- No .env file found or it doesn't contain a VCAP_SERVICES section, then check to see if the --conn parameter was specified. If so check for that file in the current directory or up to 5 parent directories
@@ -630,7 +631,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
630631
- Updated @sap/textbundle
631632
- Add readme command that opens ReadMe Documentation in your browser
632633
- Add changelog command that opens Change Log in your browser
633-
- Formatting of output copy2DefaultEnv improved for compatibility to CAP cds run
634+
- Formatting of output copy2DefaultEnv improved for compatibility to CAP cds run
634635
- New command copy2Env - copy default-env.json to .env and reformat contents
635636
- Support for HANA Cloud Instance Administration - requires cf cli to be installed and you must be logged into cf with a target org and space
636637
- Added Command: hdi to list all SAP HANA Cloud HDI container instances in your target space

0 commit comments

Comments
 (0)