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

Outdated Links and Lack of Clear Documentation #214

Open
khaledyoussef24 opened this issue Feb 8, 2024 · 2 comments
Open

Outdated Links and Lack of Clear Documentation #214

khaledyoussef24 opened this issue Feb 8, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@khaledyoussef24
Copy link
Contributor

khaledyoussef24 commented Feb 8, 2024

Many links in the README are outdated, leading to confusion for users. Additionally, there is a lack of clear documentation outlining the process of building a new image. Users would benefit from links directing them to Zinit and a guide on integrating it into their Dockerfile.
Screenshot 2024-02-08 at 11 15 34 AM

Screenshot 2024-02-08 at 10 59 01 AM

zinit link which should be included : https://github.com/threefoldtech/zinit
so you can follow the steps of adding a zinit.

also link of the dockerfile in the zinit repo needs to be updated.

Screenshot 2024-02-08 at 11 05 55 AM Screenshot 2024-02-08 at 11 06 03 AM

Feature Request:

Template Dockerfile: Provide templates of Dockerfiles in the documentation to assist users in creating their images effortlessly.
Enhancement Tips: Offer tips and best practice examples to help users enhance their images effectively.
Users should be guided on how to add their data files, particularly if the solution includes migration options.

@khaledyoussef24 khaledyoussef24 added the documentation Improvements or additions to documentation label Feb 8, 2024
@khaledyoussef24
Copy link
Contributor Author

found another issue mentioning the same problem in the zinit repo
threefoldtech/zinit#47

@khaledyoussef24
Copy link
Contributor Author

can we update the readme and also add for all image the entry point for every image

@xmonader xmonader modified the milestone: 3.15.x Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants