Skip to content

Update deployment instructions with the correct commands #557

Open
ericsandu wants to merge 3 commits intounikraft:mainfrom
ericsandu:ericsandu/fix-readme-inconsistencies
Open

Update deployment instructions with the correct commands #557
ericsandu wants to merge 3 commits intounikraft:mainfrom
ericsandu:ericsandu/fix-readme-inconsistencies

Conversation

@ericsandu
Copy link
Copy Markdown
Contributor

Removes the unnecessary command line arguments that specify the location of the container, fixing #554 . With the Dockerfile being placed in the root of the repository they are not a necessity, and were the cause of the aforementioned issue.

The contribution documentation at content/docs/contributing/docs.mdx has also been updated to reflect the current top-level README, resolving #555 .

The instructions for building locally without docker have also been updated to use the npm commands from the README.

@razvand razvand self-requested a review May 3, 2026 10:07
@razvand razvand self-assigned this May 3, 2026
@razvand razvand added the enhancement New feature or request label May 3, 2026
Copy link
Copy Markdown
Contributor

@razvand razvand left a comment

Choose a reason for hiding this comment

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

See linter issue.

Also keep the use of the bind mount option for development builds (with -v: -v $(pwd):/docs -w /docs). They are required to render updates to the local directory without having to re-build the container.

@ericsandu ericsandu force-pushed the ericsandu/fix-readme-inconsistencies branch from fd650d2 to ded1961 Compare May 3, 2026 10:10
Refer to NPM as "npm"

Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
@ericsandu ericsandu force-pushed the ericsandu/fix-readme-inconsistencies branch from ded1961 to 83f7e12 Compare May 3, 2026 11:53
@ericsandu
Copy link
Copy Markdown
Contributor Author

The fixes for #554 have been moved to a separate pull request, as they are also related to the Dockerfile, which felt out of scope for this current pull request. The instructions in the contribution documentation are the same as those in the mentioned pull request.

I have also made new commits fixing the linter errors I have found in both README.md and docs.mdx.

@ericsandu ericsandu requested a review from razvand May 3, 2026 12:06
ericsandu added 2 commits May 9, 2026 11:00
Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
@ericsandu ericsandu force-pushed the ericsandu/fix-readme-inconsistencies branch from 83f7e12 to 4a0ff14 Compare May 9, 2026 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants