Skip to content

fix: problems with getting started instructions#1547

Merged
talboren merged 3 commits intokeephq:mainfrom
frwl404:anton/fix-docker
Aug 5, 2024
Merged

fix: problems with getting started instructions#1547
talboren merged 3 commits intokeephq:mainfrom
frwl404:anton/fix-docker

Conversation

@frwl404
Copy link
Copy Markdown
Contributor

@frwl404 frwl404 commented Aug 5, 2024

Closes #1524

📑 Description

We have few problems, which new developers may get while following getting started instruction.

✅ Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

Anton added 2 commits August 5, 2024 17:47
Attempts to follow the instruction and run old-fashioned command (with dash) may result in error, for example this one:

```
$ docker-compose -f docker-compose.dev.yml up
ERROR: The Compose file is invalid because:
Service keep-frontend-dev has neither an image nor a build context specified. At least one must be provided.
```

or this:
```
  File "compose/service.py", line 1579, in get_container_data_volumes
KeyError: 'ContainerConfig'
```

We should use command without dash.
See for example: https://askubuntu.com/a/1508135
In some cases (I didn't have time to check what is the trigger) we migh have situations, when 'next' binary is already present in /usr/local/bin/next.
See:
keephq#1524
keephq#1546

In this case we will get an error from docker:

```
 => ERROR [8/8] RUN ln -s /usr/local/lib/node_modules/next/dist/bin/next /usr/local/bin/next                                                                                                                               0.7s
------
 > [8/8] RUN ln -s /usr/local/lib/node_modules/next/dist/bin/next /usr/local/bin/next:
0.408 ln: /usr/local/bin/next: File exists
```

We should not fail in this situation.
This fix proposed by @soylent-grin in https://github.com/keephq/keep/pull/1523/files#diff-edc66b35c9059e6f4fd75aa0f568ec86249f535bd0715516621005e8fd9e1949R22
I'm using it here just to close the issuer faster, because those PR, where it is now might be long-lasting.

*Probably it worth to understand why/when we are getting file already present, but right now I have no time for this. So I would consider this commit as workaround rather than a fix.
@vercel
Copy link
Copy Markdown

vercel bot commented Aug 5, 2024

Someone is attempting to deploy a commit to the KeepHQ Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Aug 5, 2024

CLA assistant check
All committers have signed the CLA.

@talboren talboren enabled auto-merge (squash) August 5, 2024 15:30
@vercel
Copy link
Copy Markdown

vercel bot commented Aug 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
keep ⬜️ Ignored (Inspect) Visit Preview Aug 5, 2024 3:30pm

@talboren talboren self-requested a review August 5, 2024 15:30
Copy link
Copy Markdown
Member

@talboren talboren left a comment

Choose a reason for hiding this comment

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

LGTM! thank you for the contribution! 🎉

@talboren talboren merged commit f5a6382 into keephq:main Aug 5, 2024
@frwl404 frwl404 deleted the anton/fix-docker branch August 5, 2024 15:35
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.

[📃 Docs]: Getting started documentation for developers looks to be not accurate enough.

3 participants