diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ce05f85a896..e1cef1153c3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,7 @@ Our style guide and instructions on using our page templates and components is available in the [contribution section](https://docs.docker.com/contribute/) on the website. -The following guidelines describe the ways in which you can contribute to the +The following guidelines describe how to contribute to the Docker documentation at , and how to get started. ## Reporting issues @@ -91,6 +91,9 @@ To stop the development server: 1. In your terminal, press `` to exit the file watch mode of Compose. 2. Stop the Compose service with the `docker compose down` command. +> [!NOTE] +> Alternatively, if you have installed Hugo, you can build with `hugo serve`. + ### Testing Before you push your changes and open a pull request, we recommend that you diff --git a/README.md b/README.md index 39500fb38823..d13785067dd8 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,32 @@ # Docs @ Docker -Welcome to Docker Documentation +Welcome to Docker Documentation Welcome to the Docker Documentation repository. This is the source for [https://docs.docker.com/](https://docs.docker.com/). -Feel free to send us pull requests and file issues. Our docs are completely +Feel free to send us pull requests and issues. Our docs are completely open source, and we deeply appreciate contributions from the Docker community! ## Provide feedback -We’d love to hear your feedback. Please file documentation issues only in the -Docs GitHub repository. You can file a new issue to suggest improvements or if -you see any errors in the existing documentation. +We’d love to hear your feedback! To submit feedback: +- Click **[New issue](https://github.com/docker/docs/issues/new)** on the docs repository, or +- Click **Request changes** in the right column of every page on + [docs.docker.com](https://docs.docker.com/), or +- Click **Give feedback** on of every page in the docs. -Before submitting a new issue, check whether the issue has already been -reported. You can join the discussion using an emoji, or by adding a comment to -an existing issue. If possible, we recommend that you suggest a fix to the issue -by creating a pull request. - -You can ask general questions and get community support through the [Docker -Community Slack](https://dockr.ly/comm-slack). Personalized support is available +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. 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 that issue in the project's code +Docker or have found a product bug, file an issue in the project's repository. -We've made it easy for you to file new issues. - -- Click **[New issue](https://github.com/docker/docs/issues/new)** on the docs repository and fill in the details, or -- Click **Request docs changes** in the right column of every page on - [docs.docker.com](https://docs.docker.com/) and add the details, or - - ![Request changes link](/static/assets/images/docs-site-feedback.png) - -- Click the **Give feedback** link on the side of every page in the docs. - - ![Docs feedback on each page](/static/assets/images/feedback-widget.png) - ## Contribute to Docker docs -We value your contribution. We want to make it as easy as possible to submit -your contributions to the Docker docs repository. Changes to the docs are -handled through pull requests against the `main` branch. To learn how to -contribute, see [CONTRIBUTING.md](CONTRIBUTING.md). +See [CONTRIBUTING.md](CONTRIBUTING.md). ## Copyright and license diff --git a/static/assets/images/docs-site-feedback.png b/static/assets/images/docs-site-feedback.png deleted file mode 100644 index 6fe4122f32d9..000000000000 Binary files a/static/assets/images/docs-site-feedback.png and /dev/null differ diff --git a/static/assets/images/feedback-widget.png b/static/assets/images/feedback-widget.png deleted file mode 100644 index cb5bafd042b3..000000000000 Binary files a/static/assets/images/feedback-widget.png and /dev/null differ