docs: update contributor docs #633
Conversation
MiahaCybersec
commented
May 23, 2024
MiahaCybersec
commented
- Adds steps to set up a local dev environment
- Fixes dead links/references
Signed-off-by: Miaha <[email protected]>
MiahaCybersec
requested review from
jeremyrickard,
sozercan and
ashnamehrotra
as code owners
|
Should some of these changes be made to the Copa install docs as well? |
I think its okay to leave it in one place! But could we also update https://project-copacetic.github.io/copacetic/website/contributing? it looks like the two weren't in sync with each other |
website/docs/contributing.md
Outdated
| If running Copa gives you the following error: | ||
|
|
||
| ```bash | ||
| Error: could not use docker driver: failed to solve: requested experimental feature mergeop has been disabled on the build server: only enabled with containerd image store backend | ||
| requested experimental feature diffop has been disabled on the build server: only enabled with containerd image store backend | ||
| missing required buildkit functionality | ||
| could not use buildx driver: listing workers for Build: failed to list workers: Unavailable: connection error: desc = "transport: Error while dialing: open /home/gitpod/.docker/buildx/current: no such file or directory" | ||
| could not use buildkitd driver: %!w(<nil>) | ||
| ``` | ||
|
|
||
| #### Personalizing user settings in a dev container | ||
| You will need to [enable containerd image store support](https://docs.docker.com/storage/containerd/) within Docker Engine. | ||
|
|
||
| VSCode supports applying your user settings, such as your `.gitconfig`, to a dev container through the use of [dotfiles repositories](https://code.visualstudio.com/docs/remote/containers#_personalizing-with-dotfile-repositories). This can be done through your own VSCode `settings.json` file without changing the dev container image or configuration. | ||
| > Note: Docker can eat up your disk space. If you find that your storage is rapidly being taken up after working with Copa, run `docker system prune`. This will prune all unused images, containers and caches. Running this command will not break anything. This is an issue with Docker, not with Copa. |
There was a problem hiding this comment.
Could we add this to the FAQ section instead?
There was a problem hiding this comment.
Regarding the error from lines 47-55, it looks like this is already mentioned in the quick start docs. I've removed the error from my PR so we don't repeat the same information.
There was a problem hiding this comment.
can we also remove it from the CONTRIBUTING.md file to keep it consistent?
website/docs/contributing.md
Outdated
| > ```bash | ||
| > sudo chown -R vscode:vscode /workspace/copacetic | ||
| > ``` | ||
| Copacetic requires Docker for patching some images. To install Docker, follow the [Docker installation guide](https://docs.docker.com/engine/install/). |
There was a problem hiding this comment.
| Copacetic requires Docker for patching some images. To install Docker, follow the [Docker installation guide](https://docs.docker.com/engine/install/). | |
| Copacetic requires Docker for patching images. To install Docker, follow the [Docker installation guide](https://docs.docker.com/engine/install/). |
Signed-off-by: Miaha <[email protected]>
Signed-off-by: Miaha <[email protected]>
Signed-off-by: Miaha <[email protected]>
website/docs/faq.md
Outdated
| @@ -13,6 +13,10 @@ Copa is not capable of patching vulnerabilities for compiled languages, like Go, | |||
|
|
|||
| To patch vulnerabilities for applications, you can package these applications and consume them from package repositories, like `http://archive.ubuntu.com/ubuntu/` for Ubuntu, and ensure Trivy can scan and report vulnerabilities for these packages. This way, Copa can patch the applications as a whole, though it cannot patch specific modules within the applications. | |||
|
|
|||
| ## My disk space is being filled up after using Copa. How can I fix this? | |||
|
|
|||
| This is due to Copa's reliance on Docker, which can eat up your disk space. If you find that your storage is rapidly being taken up after working with Copa, run `docker system prune`. This will prune all unused images, containers and caches. Running this command will not break anything. This is an issue with Docker, not with Copa. | |||
There was a problem hiding this comment.
| This is due to Copa's reliance on Docker, which can eat up your disk space. If you find that your storage is rapidly being taken up after working with Copa, run `docker system prune`. This will prune all unused images, containers and caches. Running this command will not break anything. This is an issue with Docker, not with Copa. | |
| If you find that your storage is rapidly being taken up after working with Copa, run `docker system prune`. This will prune all unused images, containers and caches. |
There was a problem hiding this comment.
I missed this last night. The requested change has been pushed.
Signed-off-by: Miaha <[email protected]>
|
Sorry about that! I tried to get the PR done right before work. Everything should be good to go now. |
Signed-off-by: Miaha <[email protected]>
website/docs/contributing.md
Outdated
| This project has adopted the [CNCF Code of Conduct](../../CODE_OF_CONDUCT) |
There was a problem hiding this comment.
this link should be fine? I think only the links in CONTRIBUTING.md were broken
There was a problem hiding this comment.
It seems like I missed this while I was making the requested changes. Good catch!
Taking a look at the contributor docs on the website, they haven't been updated in over a year and do not appear to match the CNCF code of conduct. What approach would be best to update the code of conduct on the website? Should we be linking directly to the CNCF code of conduct, or copying and pasting the CNCF code of conduct into the markdown file shown on the website?
There was a problem hiding this comment.
For the website, it looks like we had copy pasted it, so we can do that to update it to the latest
Signed-off-by: Miaha <[email protected]>
Signed-off-by: Miaha <[email protected]>
Signed-off-by: Miaha <[email protected]>
Signed-off-by: Miaha <[email protected]>
|
LGTM, waiting on DCO fix |
