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

#4935 - Fixed broken links to style guide and building documentation #5041

Closed
wants to merge 1 commit into from

Conversation

rpunjani
Copy link

Fixes #4935.

- What I did

Changed what "our style guide" and "building the documentation" direct to in CONTRIBUTING.md.

- Description for the changelog

In CONTRIBUTING.md, "our style guide" and "building the documentation" don't direct to broken links.

- A picture of a cute animal (not mandatory but encouraged)

image

@rpunjani rpunjani changed the title "Fixed broken links to style guide and building documentation" Fixed broken links to style guide and building documentation May 6, 2024
@rpunjani rpunjani changed the title Fixed broken links to style guide and building documentation #4935 - Fixed broken links to style guide and building documentation May 6, 2024
guide](https://docs.docker.com/opensource/doc-style) and instructions on [building
the documentation](https://docs.docker.com/opensource/project/test-and-docs/#build-and-test-the-documentation).
guide](https://docs.docker.com/contribute/style/grammar/) and instructions on [building
the documentation](https://github.com/docker/docs/blob/main/CONTRIBUTING.md).
Copy link
Member

Choose a reason for hiding this comment

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

I think we should avoid links to other github repositories here. I think let's point this to the official docs.

Suggested change
the documentation](https://github.com/docker/docs/blob/main/CONTRIBUTING.md).
the documentation](https://docs.docker.com/contribute/).

@Benehiko
Copy link
Member

Benehiko commented Oct 9, 2024

closing this in favor of #5417

@Benehiko Benehiko closed this Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Contributing document has broken links
2 participants