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.

Sign up for GitHub

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

Jump to bottom

CI: Add README into SmartModule package #40

Open
tjtelan opened this issue Jun 7, 2023 · 0 comments
Open

CI: Add README into SmartModule package #40

tjtelan opened this issue Jun 7, 2023 · 0 comments

Comments

@tjtelan
Copy link

tjtelan commented Jun 7, 2023 •
edited
Loading

The reference docs for connectors, CLI and API have automation that we either link to, or embed into the project website.

We need a pattern for all the SmartModules as well, so we can eventually keep docs in sync when we publish new versions. So when Jolt is published, we can also update its corresponding page on the website.

Following the pattern set by connectors, we should package up the README.md into the hub package, so that the website automation can just download the latest package, extract the readme, and embed it.

What we do here will set the pattern for how we maintain reference docs for the other certified SmartModules
@tjtelan tjtelan changed the title CI: Establish pattern to update docs on website CI: Add README into SmartModule package Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tjtelan