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: Update instructions for uploading components through a release #22

Merged
merged 6 commits into from
Dec 12, 2024

Conversation

agnieszka-m
Copy link
Contributor

No description provided.

Copy link
Member

@ArzelaAscoIi ArzelaAscoIi left a comment

Choose a reason for hiding this comment

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

just one nit + q

README.md Outdated Show resolved Hide resolved
README.md Outdated

### Uploading by Releasing Your Forked Directory

We use GitHub Actions to build and push custom components to deepset Cloud. The action runs the tests and code quality checks before pushing the component code to deepset Cloud. Create a tag to trigger the build and the push job.
Copy link
Member

Choose a reason for hiding this comment

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

q: Should we add that this is an optional thing ? Something like. If you want to track your custom components via a github repository, you can use GithubActions. This helps you keep track of the changes and investigate the code that is deployed to deepset cloud

Copy link
Contributor Author

Choose a reason for hiding this comment

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

so currently, we're saying it's one of the methods to upload your components, which by default means it's optional (you can choose another method and then you're not using this one). I'm wondering if adding here that it's optional would make it confusing?

Added info about tracking the code

@agnieszka-m agnieszka-m merged commit 57223dc into main Dec 12, 2024
2 checks 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