Revert "Updated outdated docker contributing guidelines link"#44826
Revert "Updated outdated docker contributing guidelines link"#44826neersighted wants to merge 1 commit into
Conversation
This reverts commit 1fdfd45. Unfortunately, I did not catch that this link is actually entirely unrelated to contributing to Moby projects during review (in fact, it only relates to docs.docker.com). Given it is misleading and makes an effort to restore these links to working condition harder, I am going to back it out for now. At least the fully broken link will prompt the intrepid contributor to consult web.archive.org instead of being baffled by the unrelated content. Anyone interested in trying to repair the docs to a working state is encouraged to reach out; I'll be trying to do some work here myself, and I can also connect you to other interested contributors. Signed-off-by: Bjorn Neergaard <bneergaard@mirantis.com>
|
Not sure we should revert; perhaps better to update it to link to the in-repo files (https://github.com/moby/moby/tree/master/docs/contributing), which to my knowledge are the same files as the ones that were at https://docs.docker.com/opensource/workflow/make-a-contribution/ |
|
They're note quite the same files and much of the information referenced by that particular link in CONTRIBUTING.md is missing. You can see the originals at https://github.com/docker/docs/tree/7cfe2e9da240cd9d2dc475593af1a4840a518614/opensource. I'd rather revert this so that a straightforward find-and-replace can be performed when equivalents are provided, instead of having to scan the text and replace a 'good enough' link with a more correct one. |
|
I guess what's missing is the index, which links some of the pages together (from that link you posted in #44373 (comment)); https://github.com/docker/docs/blob/7cfe2e9da240cd9d2dc475593af1a4840a518614/opensource/index.md Although the README currently does contain the essentials (might need a bit of a tweak); |
|
I suppose that it wouldn't be the end of the world to replace the index links with the current index, but there are also references to the advanced contribution guide + review guide, as well as simpler richer docs there that the CONTRIBUTING.md text implies the existence of. If you think it won't be forgotten half-done/a pain to remember this conversation when we do clean this up, I'm fine with replacing the index links, but there will still be docs.docker.com links that 404 with no in-tree equivalent, and perhaps less drive to fix that. |
Following the discussion on moby#44826 and its summary in CONTRIBUTING.md, the advanced-contributing page was added. Based on https://github.com/docker/docs/blob/7cfe2e9da240cd9d2dc475593af1a4840a518614/opensource/workflow/advanced-contributing.md and adjusted for moby. Signed-off-by: Signed-off-by: Snir Ilani <marcalath@gmail.com>
|
Hey @neersighted , @thaJeztah , I gave it a go, let me know what you think :) |
Following the discussion on moby#44826 and its summary in CONTRIBUTING.md, the advanced-contributing page was added. Based on https://github.com/docker/docs/blob/7cfe2e9da240cd9d2dc475593af1a4840a518614/opensource/workflow/advanced-contributing.md and adjusted for moby. Signed-off-by: Snir Ilani <marcalath@gmail.com>
Following the discussion on moby#44826 and its summary in CONTRIBUTING.md, the advanced-contributing page was added. Based on https://github.com/docker/docs/blob/7cfe2e9da240cd9d2dc475593af1a4840a518614/opensource/workflow/advanced-contributing.md and adjusted for moby. Signed-off-by: Snir Ilani <marcalath@gmail.com>
| quickly. If your pull request is not accepted on the first try, | ||
| don't get discouraged! Our contributor's guide explains [the review process we | ||
| use for simple changes](https://docs.docker.com/contribute/overview/). | ||
| use for simple changes](https://docs.docker.com/opensource/workflow/make-a-contribution/). |
There was a problem hiding this comment.
Can we just remove this sentence (temporarily)?
This reverts commit 1fdfd45.
Unfortunately, I did not catch that this link is actually entirely unrelated to contributing to Moby projects during review (in fact, it only relates to docs.docker.com).
Given it is misleading and makes an effort to restore these links to working condition harder, I am going to back it out for now. At least the fully broken link will prompt the intrepid contributor to consult web.archive.org instead of being baffled by the unrelated content.
Anyone interested in trying to repair the docs to a working state is encouraged to reach out; I'll be trying to do some work here myself, and I can also connect you to other interested contributors.
cc @KirkEasterson