Fix, and update contributing guide#45026
Conversation
98f7e0c to
eb82012
Compare
neersighted
left a comment
There was a problem hiding this comment.
Thanks for taking this one! Some initial feedback; and also I'm not sure we currently want to push people to do the "PR a markdown proposal" workflow as we have not actually done that for some time.
Still, it's a lot of work to update this, thanks so much for contributing and working on resolving this sharp edge 😄
|
|
||
| 3. Discuss with the community: | ||
|
|
||
| Check out our [community page](https://mobyproject.org/community/), where you'll find links to our [Twitter account](https://twitter.com/moby), [Slack channel](https://dockr.ly/comm-slack) and [forum](https://forums.mobyproject.org/). |
There was a problem hiding this comment.
@thaJeztah do we still want to plug the forum or twitter?
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>
Link updated from https://docs.docker.com/engine/installation/ to https://docs.docker.com/engine/install/ and inline HTML formatting was replaced by md link formatting. Signed-off-by: Snir Ilani <marcalath@gmail.com>
Referenced in docs/contributing/advanced-contributing.md Signed-off-by: Snir Ilani <marcalath@gmail.com>
Broken docs.docker.com links were replaced with updated ones. Community Slack link was updated. Doc-style redirects to Docker's grammer reference - which presents a similar notion. Signed-off-by: Snir Ilani <marcalath@gmail.com>
Signed-off-by: Snir Ilani <marcalath@gmail.com>
Following the review process in moby#45026: >> CONTRIBUTING.md << - Slack link was fixed in href too - image was brushed and now it does not include an in-image-link - image now links to who-written-for.md >> advanced-contributing.md << - PR title format updated Signed-off-by: Snir Ilani <marcalath@gmail.com>
eb82012 to
7cb2481
Compare
|
Hey @neersighted , sure, I'm happy to help :) |
|
In |
|
Oh, OK :) So I'm guessing we'll wait for more maintainers to comment on this one - @thaJeztah maybe? |
|
Precisely, no action needed from you until we figure out what workflow we want to document 😆 |
Signed-off-by: Snir Ilani <marcalath@gmail.com>
The contribution guide now has a unified flow: - who-written-for.md was more appropriately renamed getting-started.md and links to the file were updated. - The links in the different contribution docs were updated, and form a unified flow. see docs/contributing/README.md for the steps. - doc files were updated with links to the following step in the guide to form the unified flow. Signed-off-by: Snir Ilani <marcalath@gmail.com>
No issue raised yet - but this change should probably be updated following moby#45026 as it duplicates a little, and will conflict. Signed-off-by: Rob Murray <rob.murray@docker.com>
|
These changes look great ... I've got some mostly-separate minor tweaks lined up, but I'll hold off until this PR is merged. (But, I'm new here! So can't answer the questions that have been raised.) |
- What I did
Fixed the broken links in the documentation, following the discussion in #44826
- How I did it
Added the missing documentation mentioned, fixed the links and added an updated image.
- How to verify it
Click the links.
- Description for the changelog
Fix broken contributing documentation links
fixes #45024
- A picture of a cute animal (not mandatory but encouraged)
