Docs modify - #1384
Open
inshane13 wants to merge 9 commits into
Open
Conversation
- Enable ReadTheDocs versioning in .readthedocs.yaml with tag patterns and multiple formats - Update version references from 0.6.0 to 0.7.0 across all platform guides - Add comprehensive Enterprise content to platform guides: - AWS EMR: Full Community + Enterprise guide with JAR setup, Python packages, phases - GCP Dataproc: Enterprise tab with EArguments, EZinggWithSpark, blocking strategies - Microsoft Fabric: Enterprise tab with 7-notebook workflow, EC/ES packages - Snowflake: Complete Enterprise Snowflake guide with Snowpark, native execution - Clean up placeholder comments: - Remove 22 'IMAGE TO BE ADDED' placeholders - Remove 'CONTENT TO BE GIVEN', 'TO BE ADDED', 'CHECK WITH SONAL' internal notes - Remove 'VIDEO TO BE ADDED' placeholder - Fix broken links (e.g., /broken/pages/... -> proper references) - Add missing frontmatter descriptions to 75+ markdown files - Update Snowflake properties page with detailed parameter docs and key-pair auth - Update install-zingg.md with AWS Glue, GCP Dataproc, Azure Synapse tabs - Add GitHub Actions workflow for docs validation (markdown links, Sphinx build, frontmatter, version consistency) - Remove TODO comments from verify-blocking.md and zingg-concepts README
…zinggAI#1363) - Create new authoritative page: enterprise-snowflake-instructions.md with complete guide for running Zingg Enterprise natively on Snowflake using Snowpark - Covers: Marketplace/manual installation, Snowpark session setup, Snowflake object creation (warehouse, database, stage, roles), B2B Customer Accounts and Enterprise Vendor Profiles configuration examples - Includes MAPPING match type examples for company/vendor aliases (Alphabet Inc./Google LLC, Microsoft Corp/MSFT, Dell/EMC, etc.) - Full pipeline: findTrainingData → label (Snowsight UI) → generateDocs → train → match → incremental matching - Both Python and SQL APIs documented - B2B score bands (0.90+ auto-merge, 0.75-0.89 steward review, 0.50-0.74 deep review, <0.50 separate) - Monitoring via Snowflake Query History, security best practices (key-pair auth, network policies, column masking) - Troubleshooting quick reference and performance tuning guide - Update SUMMARY.md to include new page under Installing Zingg Enterprise for Snowflake - Cross-link from connect-snowflake.md, platform-guide-for-snowflake.md, and install-zingg.md - Update README.md for the Snowflake Enterprise installation section with proper frontmatter
- Add markdownlint to CI with a GitBook-compatible .markdownlint-cli2.jsonc config (only Docs Validation workflow step) - Link Enterprise Snowflake cross-references to the correct relative paths - Fix broken internal links (Sphinx-generated API index pages excluded via link-check config; dead /broken/ GitBook placeholder links removed) - Add official Zingg YouTube demo embed and product screenshot placeholders to the Enterprise Snowflake instructions - Convert remaining GitBook inline HTML tables to Markdown (41 tables in 30 files) and replace   entities - Clean up placeholder/garbage content across docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
issue - #1363
Restyled the entire published docs site (115 navigated pages) to be "presentation-grade, PPT-like" using GitBook styling levers, preserving ALL original content. Section-by-section review completed with validation checkpoints.