diff --git a/README.md b/README.md index 76c62a3570..ff7305c2b8 100644 --- a/README.md +++ b/README.md @@ -14,23 +14,34 @@ 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. -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. +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](http://dockr.ly/slack). Personalized support is available through the Docker Pro, Team, and Business subscriptions. See [Docker Pricing](https://www.docker.com/pricing) for details. +You can ask general questions and get community support through the [Docker +Community Slack](http://dockr.ly/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 repository. +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 +repository. We've made it really easy for you to file new issues. - Click **New issue** 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 and add the details. +- Click **Request docs changes** in the right column of every page on + docs.docker.com and add the details. ![Docs feedback on each page](/opensource/images/docs-site-feedback.png) ## Contribute to Docker docs -We value your contribution. We'd like 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 `master` branch. To learn how to contribute, see [CONTRIBUTING.md](CONTRIBUTING.md). +We value your contribution. We'd like 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 `master` branch. To learn how to +contribute, see [CONTRIBUTING.md](CONTRIBUTING.md). ## Copyright and license diff --git a/images/docker-docs.png b/images/docker-docs.png index da853f91f0..89bebf552c 100644 Binary files a/images/docker-docs.png and b/images/docker-docs.png differ diff --git a/opensource/index.md b/opensource/index.md index 07070371af..9205200578 100644 --- a/opensource/index.md +++ b/opensource/index.md @@ -34,28 +34,46 @@ redirect_from: Contributing to the Docker documentation can be a rewarding experience. When you offer feedback, questions, edits, or new content, you help us, the projects you -work on, and the larger Docker community. Feel free to create pull requests and file issues. Our docs are completely open source and we deeply appreciate contributions from the Docker community! +work on, and the larger Docker community. Feel free to create pull requests and +file 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. 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. -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. +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](http://dockr.ly/slack). Personalized support is available through the Docker Pro, Team, and Business subscriptions. See [Docker Pricing](https://www.docker.com/pricing) for details. +You can ask general questions and get community support through the [Docker +Community Slack](http://dockr.ly/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 repository. +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 +repository. We've made it really easy for you to file new issues. - Click **New issue** 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 and add the details. +- Click **Request docs changes** in the right column of every page on + docs.docker.com and add the details. ![Docs feedback on each page](/opensource/images/docs-site-feedback.png) ## Contribute to Docker docs -We value your contribution. We'd like 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 `master` branch. To learn how to contribute, see [CONTRIBUTING.md](https://github.com/docker/docker.github.io/blob/master/CONTRIBUTING.md). +We value your contribution. We'd like 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 `master` branch. To learn how to +contribute, see +[CONTRIBUTING.md](https://github.com/docker/docker.github.io/blob/master/CONTRIBUTING.md). -For a demo of the components, tags, Markdown syntax, styles, used in Docker documentation, see [test.md](https://github.com/docker/docker.github.io/blob/master/test.md). +For a demo of the components, tags, Markdown syntax, styles, used in Docker +documentation, see +[test.md](https://github.com/docker/docker.github.io/blob/master/test.md). diff --git a/test.md b/test.md index 5535e28281..dbda9d3f08 100644 --- a/test.md +++ b/test.md @@ -91,7 +91,6 @@ culpa qui officia deserunt mollit anim id est laborum. ### Links - [a markdown link](https://docker.com/) -https://github.com/docker/docker.github.io/tree/master/docker-cloud/images - [a markdown link that opens in a new window](https://docker.com/){: target="_blank" rel="noopener" class="_" } (the `class="_"` trick prevents Atom from italicizing the whole rest of the file until it encounters another underscore.) @@ -161,7 +160,8 @@ might be interesting. You can use them with Markdown or HTML images. ## Videos -To embed a YouTube video on a docs page, open the video on YouTube, click **Share** > **Embed** and then copy the code displayed. +To embed a YouTube video on a docs page, open the video on YouTube, click +**Share** > **Embed** and then copy the code displayed. For example, the video embedded on the Get Started page has the following code: