Skip to content

Remove "file://" component references from public docs#39

Merged
dlicheva merged 1 commit intomainfrom
remove-file-component-references-from-public-quickstart-docs
Aug 18, 2025
Merged

Remove "file://" component references from public docs#39
dlicheva merged 1 commit intomainfrom
remove-file-component-references-from-public-quickstart-docs

Conversation

@northdpole
Copy link
Contributor

A benefit of smithy is that you don't need the source code of every single connector in order to run it. If our docs have workflows that only reference file:// type components, then our users can't benefit from this. This gets increasingly frustrating as the repo gets larger, especially since we're vendoring components. This commit rewrites docs to replace file:// type references to components with ghcr:// type references to components. It also slightly cleans up the 'how to write a workflow' piece of the open source docs explaining the difference between file:// component references used mostly for development and 'ghcr://' type component references used for day to day operations. It also documents how the component registry works and how to use it.

A benefit of smithy is that you don't need the source code of every
single connector in order to run it. If our docs have workflows that only reference file:// type components, then our users can't benefit from this.
This gets increasingly frustrating as the repo gets larger, especially since we're vendoring components.
This commit rewrites docs to replace file:// type references to
components with ghcr:// type references to components.
It also slightly cleans up the 'how to write a workflow' piece of the
open source docs explaining the difference between file:// component
references used mostly for development and 'ghcr://' type component
references used for day to day operations. It also documents how the
component registry works and how to use it.
@northdpole northdpole force-pushed the remove-file-component-references-from-public-quickstart-docs branch from ddee7a6 to f1321bd Compare August 15, 2025 21:34
@dlicheva dlicheva self-requested a review August 18, 2025 12:42
Copy link
Contributor

@dlicheva dlicheva left a comment

Choose a reason for hiding this comment

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

Thank you 🙌

@dlicheva dlicheva merged commit b9d3f21 into main Aug 18, 2025
1 check passed
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.

2 participants