Move documentation into repository#169
Open
jeromatron wants to merge 18 commits into
Open
Conversation
- Added breadcrumb navigation showing hierarchical location to all 55 doc pages - Added Quick Links section providing access to main documentation sections - Updated root README.md to link to local docs/ directory instead of external URLs - Added Java compatibility matrix to docs/intro/compatibility.md - Root README now links to compatibility documentation (single source of truth) - All navigation uses consistent formatting with horizontal rule separators - Breadcrumbs use 📘 emoji for visual appeal - Current location in breadcrumbs shown as plain text (not a link) This improves navigation in GitHub's Markdown rendering which doesn't support sidebars.
GitHub was rendering the YAML frontmatter as a table instead of hiding it. Since the frontmatter was metadata from the original HTML docs and isn't needed for GitHub Markdown rendering, removed it from all 54 doc files. Files now start directly with the breadcrumb navigation.
Made the compatibility guide more discoverable by adding it as a sub-item under Introduction in the Quick Links section.
- Created docs/faq.md with comprehensive FAQ covering: - Compatibility (Java, Kafka, databases, data formats) - Installation and configuration - Data mapping and operations - Monitoring and troubleshooting - Links to detailed guides throughout - Added FAQ to Quick Links navigation bar on all 54 documentation pages - Updated docs/README.md to include FAQ in main Quick Links section - Updated root README.md to link to FAQ instead of compatibility page The FAQ provides a single, easy-to-find location for common questions including Java compatibility matrix, making it more discoverable than having it nested under Introduction.
- Standardized Quick Links navigation bar across all pages - Moved 'Cycling comments example' link to consistent position (after Config) - Added missing 'Cycling comments example' link to mapping page - All pages now have identical navigation order
These were unintentional pre-edit snapshots committed alongside the real doc changes and aren't meant to be tracked.
Member
|
This looks good to me (sans the antora stuffs or the hook to get built automatically and get published when changes are merged into |
|
|
||
| ``` | ||
| name=dse-sink | ||
| connector.class=com.datastax.kafkaconnector.DseSinkConnector |
Collaborator
There was a problem hiding this comment.
Update to com.datastax.oss.kafka.sink.CassandraSinkConnector as com.datastax.kafkaconnector.DseSinkConnector is deprecated.
| **connector.class** | ||
| : DataStax connector Java class provided in the | ||
| `kafka-connect-cassandra-sink-N.N.N.jar` | ||
| Default: `com.datastax.kafkaconnector.CassandraSinkConnector` |
Collaborator
There was a problem hiding this comment.
com.datastax.oss.kafka.sink.CassandraSinkConnector is the default.
| { | ||
| "name": "stocks-sink", | ||
| "config": { | ||
| "connector.class": "com.datastax.kafkaconnector.DseSinkConnector", |
Collaborator
There was a problem hiding this comment.
replace all occurrences of com.datastax.kafkaconnector.DseSinkConnector with com.datastax.oss.kafka.sink.CassandraSinkConnector
|
|
||
| ### How do I configure SSL/TLS connections? | ||
|
|
||
| See the [SSL Configuration Guide](security/ssl.md) for detailed SSL/TLS setup instructions. |
Collaborator
There was a problem hiding this comment.
Replace security/ssl.md with config/ssl.md
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
3 participants
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.
Summary
docs/, organized by topic (intro, install, config, mapping, monitoring, operations, security, troubleshooting, tutorials, release-notes).README.mdto link to the local docs instead of external URLs..backupfiles that were unintentionally committed alongside the docs restructuring.