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

Generate connector docs #200

Open
wants to merge 32 commits into
base: main
Choose a base branch
from
Open

Generate connector docs #200

wants to merge 32 commits into from

Conversation

hariso
Copy link
Contributor

@hariso hariso commented Dec 6, 2024

Closes #167.

Here's how the updated connectors' list and a new connector's page look like:

Connectors list (and search)

Screenshot from 2024-12-20 20-48-37

A generated page

Screenshot from 2024-12-20 20-47-47

Copy link

cloudflare-workers-and-pages bot commented Dec 6, 2024

Deploying conduit-site with  Cloudflare Pages  Cloudflare Pages

Latest commit: ed77f8e
Status: ✅  Deploy successful!
Preview URL: https://28b03f5e.conduit-site.pages.dev
Branch Preview URL: https://haris-generate-connector-doc.conduit-site.pages.dev

View logs

static/connectors.json Outdated Show resolved Hide resolved
static/connectors.json Outdated Show resolved Hide resolved
@hariso hariso marked this pull request as ready for review December 9, 2024 14:40
@hariso hariso requested a review from a team as a code owner December 9, 2024 14:40
Copy link
Member

@raulb raulb left a comment

Choose a reason for hiding this comment

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

@hariso on https://github.com/ConduitIO/conduit-site/pull/203/files#diff-7a45f875fcea055cb151d9ae10b11385301584ae2bd1a9b111ea0b6c8e307c66, I went through the process of removing the artifacts and only link to the latest release which means we would be able to remove the IsLatest release check. I believe we should simplify that bit, and only show the relevant information there.

Another suggestion I have is to use the name of the connector as a link instead of expanding the accordion of releases, eliminating the View docs link.

What do you think?

@hariso hariso enabled auto-merge (squash) December 23, 2024 13:48
@hariso hariso requested a review from raulb December 23, 2024 13:48
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.

doc: Generate documentation page for each connector
2 participants