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

feat: Add Introducing the Devfile AI Assistant blog post #55

Merged
merged 10 commits into from
Jun 21, 2024

Conversation

tolusha
Copy link
Contributor

@tolusha tolusha commented Jun 18, 2024

Signed-off-by: Anatolii Bazko <[email protected]>
@ibuziuk
Copy link
Member

ibuziuk commented Jun 19, 2024

Great read! The only recommendation would be adding a What is a devfile section that would laconically explain what is it and how it is used in Eclipse Che:

Screenshot 2024-06-19 at 10 27 37

@l0rd
Copy link
Contributor

l0rd commented Jun 19, 2024

👍 @tolusha. I like that.

I have a few suggestions:

  • Mention the VS Code walkthrough extension that is less fancy but that does the job too.
  • Avoid using as an example the Add a project to the devfile. This controversial. The suggestion is to add the Devfile to the project rather than hardcode the URL and branch in the Devfile.
  • Add a prompt that pushes further ChatGPT capabilities so that it does a task that is usually tedious and difficult for users. Some ideas that come to my mind:
    • "Update the component image to build and test the source code in the repository "
    • "Write a Dockerfile to extend the universal developer image to include the development tool and write a GitHub workflow to build and push the image automatically" etc...

Signed-off-by: Anatolii Bazko <[email protected]>
Signed-off-by: Anatolii Bazko <[email protected]>
Signed-off-by: Anatolii Bazko <[email protected]>
@tolusha
Copy link
Contributor Author

tolusha commented Jun 19, 2024

Hello @l0rd
I've mentioned the VSCode walk-through extension in the blog post.
With regards to the other remarks:

Avoid using as an example the Add a project to the devfile. eclipse-che/che#21188. The suggestion is to add the Devfile to the project rather than hardcode the URL and branch in the Devfile.

The idea is to show that Devfile AI Assistant can easily do any task related to a devfile.
So, if specification allows to do it, than it make sense to show off.

Add a prompt that pushes further ChatGPT capabilities so that it does a task that is usually tedious and difficult for users. Some ideas that come to my mind:

Devfile AI Assistant is specifically configured by its instructions to help a developer to create the Devfile from the scratch.
It utilizes devfile specification and other resources. So, the mentioned prompts are a bit out of context right now and can be used to improve the Assistant in the future.

@l0rd
Copy link
Contributor

l0rd commented Jun 20, 2024

The idea is to show that Devfile AI Assistant can easily do any task related to a devfile.
So, if specification allows to do it, than it makes sense to show off.

That's not a big issue but I think it's important to be on the same page about projects. The devfile is the configuration file of your project development environment. Its place is in your project git repository. The git repo URL is implicit.

Copy link
Member

@ibuziuk ibuziuk left a comment

Choose a reason for hiding this comment

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

great article 👍
Added a few minor improvements which hopefully make it even more awesome

@tolusha tolusha merged commit bd6a989 into main Jun 21, 2024
8 checks passed
@tolusha tolusha deleted the devfileaiassistant branch June 21, 2024 09:45
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.

4 participants