Skip to content

Commit 007148b

Browse files
authored
readme: update content (#23109)
## Description Shorten content, remove outdated screenshots.
1 parent c7f64f3 commit 007148b

File tree

4 files changed

+14
-30
lines changed

4 files changed

+14
-30
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Our style guide and instructions on using our page templates and components is
77
available in the [contribution section](https://docs.docker.com/contribute/) on
88
the website.
99

10-
The following guidelines describe the ways in which you can contribute to the
10+
The following guidelines describe how to contribute to the
1111
Docker documentation at <https://docs.docker.com/>, and how to get started.
1212

1313
## Reporting issues
@@ -91,6 +91,9 @@ To stop the development server:
9191
1. In your terminal, press `<Ctrl+C>` to exit the file watch mode of Compose.
9292
2. Stop the Compose service with the `docker compose down` command.
9393

94+
> [!NOTE]
95+
> Alternatively, if you have installed Hugo, you can build with `hugo serve`.
96+
9497
### Testing
9598

9699
Before you push your changes and open a pull request, we recommend that you

README.md

Lines changed: 10 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,32 @@
11
# Docs @ Docker
22

3-
<img src="static/assets/images/docker-docs.png" alt="Welcome to Docker Documentation" style="max-width: 50%;">
3+
<img src="static/assets/images/docker-docs.png" alt="Welcome to Docker Documentation" style="max-width: 45%;">
44

55
Welcome to the Docker Documentation repository. This is the source for
66
[https://docs.docker.com/](https://docs.docker.com/).
77

8-
Feel free to send us pull requests and file issues. Our docs are completely
8+
Feel free to send us pull requests and issues. Our docs are completely
99
open source, and we deeply appreciate contributions from the Docker community!
1010

1111
## Provide feedback
1212

13-
We’d love to hear your feedback. Please file documentation issues only in the
14-
Docs GitHub repository. You can file a new issue to suggest improvements or if
15-
you see any errors in the existing documentation.
13+
We’d love to hear your feedback! To submit feedback:
14+
- Click **[New issue](https://github.com/docker/docs/issues/new)** on the docs repository, or
15+
- Click **Request changes** in the right column of every page on
16+
[docs.docker.com](https://docs.docker.com/), or
17+
- Click **Give feedback** on of every page in the docs.
1618

17-
Before submitting a new issue, check whether the issue has already been
18-
reported. You can join the discussion using an emoji, or by adding a comment to
19-
an existing issue. If possible, we recommend that you suggest a fix to the issue
20-
by creating a pull request.
21-
22-
You can ask general questions and get community support through the [Docker
23-
Community Slack](https://dockr.ly/comm-slack). Personalized support is available
19+
To get community support, use the [Docker Community Slack](https://dockr.ly/comm-slack). Personalized support is available
2420
through the Docker Pro, Team, and Business subscriptions. See [Docker
2521
Pricing](https://www.docker.com/pricing) for details.
2622

2723
If you have an idea for a new feature or behavior change in a specific aspect of
28-
Docker or have found a product bug, file that issue in the project's code
24+
Docker or have found a product bug, file an issue in the project's
2925
repository.
3026

31-
We've made it easy for you to file new issues.
32-
33-
- Click **[New issue](https://github.com/docker/docs/issues/new)** on the docs repository and fill in the details, or
34-
- Click **Request docs changes** in the right column of every page on
35-
[docs.docker.com](https://docs.docker.com/) and add the details, or
36-
37-
![Request changes link](/static/assets/images/docs-site-feedback.png)
38-
39-
- Click the **Give feedback** link on the side of every page in the docs.
40-
41-
![Docs feedback on each page](/static/assets/images/feedback-widget.png)
42-
4327
## Contribute to Docker docs
4428

45-
We value your contribution. We want to make it as easy as possible to submit
46-
your contributions to the Docker docs repository. Changes to the docs are
47-
handled through pull requests against the `main` branch. To learn how to
48-
contribute, see [CONTRIBUTING.md](CONTRIBUTING.md).
29+
See [CONTRIBUTING.md](CONTRIBUTING.md).
4930

5031
## Copyright and license
5132

-21.1 KB
Binary file not shown.
-4.2 KB
Binary file not shown.

0 commit comments

Comments
 (0)