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.

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

docs: connectors #1746

Merged
merged 1 commit into from
May 17, 2024
Merged

docs: connectors #1746

merged 1 commit into from
May 17, 2024

Conversation

snkas
Copy link
Contributor

@snkas snkas commented May 13, 2024

Improves the connectors documentation:

  • General connectors index
  • Input connectors
  • Output connectors

Is this a user-visible change (yes/no): yes

@lalithsuresh
Copy link
Collaborator

lalithsuresh commented May 13, 2024

@snkas This is a great start! Thanks for working on this. Main suggestions (you can also do these over multiple PRs):

  • More examples for specific workflows people are trying to accomplish would be nice. I like the "from curl" and "from python" examples (which shows, given a connector json object, how you'd apply it). Perhaps also show several examples of connector json objects for common needs (e.g., Kafka without authentication, Kafka with SSL, Kafka when connecting to Confluent, Kafka with certificates etc). The HTTP connector also has several examples you could show.
  • Do a language revision to prefer active voice over passive voice.

docs/connectors/index.mdx Outdated Show resolved Hide resolved
docs/connectors/index.mdx Outdated Show resolved Hide resolved
docs/connectors/index.mdx Outdated Show resolved Hide resolved
docs/connectors/index.mdx Show resolved Hide resolved
docs/connectors/index.mdx Outdated Show resolved Hide resolved
docs/connectors/sources/http.md Show resolved Hide resolved
docs/connectors/sources/http.md Outdated Show resolved Hide resolved
docs/connectors/sources/http.md Outdated Show resolved Hide resolved
docs/connectors/sources/kafka.md Outdated Show resolved Hide resolved
docs/connectors/index.mdx Show resolved Hide resolved
@snkas snkas requested review from lalithsuresh, mihaibudiu and ryzhyk and removed request for mihaibudiu May 15, 2024 14:15
Copy link
Contributor

@ryzhyk ryzhyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff, thanks, @snkas !

docs/connectors/sources/kafka.md Outdated Show resolved Hide resolved
docs/connectors/index.mdx Outdated Show resolved Hide resolved
Signed-off-by: Simon Kassing <simon.kassing@feldera.com>
@snkas snkas merged commit 8439215 into main May 17, 2024
5 checks passed
@snkas snkas deleted the connector-docs branch May 17, 2024 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants