Enhance Docker Docs README: Fix Issues, Improve Clarity, and Update Contribution Guidelines #23643
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Hi maintainers 👋 This is a small and straightforward contribution (minor text/API addition) with no breaking changes. If everything looks good, could you please merge this PR at your earliest convenience? Thank you for maintaining this amazing project! 🙏 |
| <br/> | ||
|
|
||
| Welcome to the Docker Documentation repository. This is the source for the [Docker Docs Website](https://docs.docker.com/). | ||
| Welcome to the Docker Documentation repository. This is the official Docker documentation. |
There was a problem hiding this comment.
This sentence was fine as is, please rever the change
| Welcome to the Docker Documentation repository. This is the official Docker documentation. | ||
|
|
||
| Feel free to open pull requests or issues. Our docs are completely open source, and we deeply appreciate contributions from the Docker community! | ||
| Feel free to open pull requests or issues. Our docs are completely open source and encourage community contributions. |
There was a problem hiding this comment.
Please revert the change, original way was clearer
| Feel free to open pull requests or issues. Our docs are completely open source and encourage community contributions. | ||
|
|
||
| ## Provide feedback | ||
| ## How to Provide Feedback |
There was a problem hiding this comment.
Needs sentence case as per our style guide rules
| To get community support, use the [Docker Community Slack](https://dockr.ly/comm-slack). Personalized support is available | ||
| through the Docker Pro, Team, and Business subscriptions. See [Docker | ||
| Pricing](https://www.docker.com/pricing) for details. | ||
| To get community support, use the [Docker Community Slack](https://dockr.ly/community-support) through the Docker Pro, Team, and Business subscriptions. See [Docker Pricing](https://www.docker.com/pricing) for details. |
There was a problem hiding this comment.
Please revert this change as it's changed the fundamental meaning of the sentence
| If you have an idea for a new feature or behavior change in a specific aspect of Docker or have found a product bug, file an issue in the project repository on GitHub. | ||
|
|
||
| ## Contribute to Docker docs | ||
| ## Contributing to Docker Documentation |
2 participants
This pull request significantly improves the Docker Documentation repository's README by addressing multiple issues including truncated text, broken links, and outdated phrases. The content has been modernized for better readability and clearer instructions on providing feedback and contributing to the docs. Key enhancements include: