From 4e6a01023b7422dc3df7f02e248bb06361069fcc Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Sun, 8 Mar 2015 15:41:08 +0100 Subject: [PATCH] cleanup: docs: remove temporary inline styles Some inline ` - - - +
@@ -79,13 +73,7 @@ the easiest way to connect to IRC. 2. Fill out the form. - - -
+
diff --git a/docs/sources/project/make-a-contribution.md b/docs/sources/project/make-a-contribution.md index c68ed6818b..b6fc4f34fa 100644 --- a/docs/sources/project/make-a-contribution.md +++ b/docs/sources/project/make-a-contribution.md @@ -2,40 +2,12 @@ page_title: Understand how to contribute page_description: Explains basic workflow for Docker contributions page_keywords: contribute, maintainers, review, workflow, process - - - - - # Understand how to contribute Contributing is a process where you work with Docker maintainers and the -community to improve Docker. The maintainers are experienced contributors who specialize in one or more Docker components. Maintainers play a big role in reviewing contributions. +community to improve Docker. The maintainers are experienced contributors +who specialize in one or more Docker components. Maintainers play a big role +in reviewing contributions. There is a formal process for contributing. We try to keep our contribution process simple so you'll want to contribute frequently. @@ -59,4 +31,5 @@ contributions. When you reach that point in the flow, we make sure to tell you. ## Where to go next -Now that you know a little about the contribution process, go to the next section to [find an issue you want to work on](/project/find-an-issue/). +Now that you know a little about the contribution process, go to the next section +to [find an issue you want to work on](/project/find-an-issue/). diff --git a/docs/sources/project/set-up-dev-env.md b/docs/sources/project/set-up-dev-env.md index 02cffcc112..637eef6f58 100644 --- a/docs/sources/project/set-up-dev-env.md +++ b/docs/sources/project/set-up-dev-env.md @@ -2,14 +2,6 @@ page_title: Work with a development container page_description: How to use Docker's development environment page_keywords: development, inception, container, image Dockerfile, dependencies, Go, artifacts - - - - # Work with a development container In this section, you learn to develop like a member of Docker's core team. @@ -44,7 +36,7 @@ To remove unnecessary artifacts. You should see something similar to the following: -
Nickname The short name you want to be known as in IRC.
+
@@ -66,7 +58,7 @@ To remove unnecessary artifacts. You should see something similar to the following: -
CONTAINER ID IMAGE
+
@@ -128,7 +120,7 @@ environment. You should see something similar to this: -
REPOSITORY TAG
+
@@ -292,7 +284,7 @@ build and run a `docker` binary in your container. $ docker ps -
REPOSTITORY TAG
+
diff --git a/docs/sources/project/test-and-docs.md b/docs/sources/project/test-and-docs.md index c1c422e724..d586ea2c3c 100644 --- a/docs/sources/project/test-and-docs.md +++ b/docs/sources/project/test-and-docs.md @@ -2,13 +2,6 @@ page_title: Run tests and test documentation page_description: Describes Docker's testing infrastructure page_keywords: make test, make docs, Go tests, gofmt, contributing, running tests - - - # Run tests and test documentation Contributing includes testing your changes. If you change the Docker code, you @@ -59,35 +52,35 @@ The `Makefile` contains a target for the entire test suite. The target's name is simply `test`. The make file contains several targets for testing: -
CONTAINER ID IMAGE
+
- + - + - + - + - + - +
Target What this target does
testtest Run all the tests.
test-unittest-unit Run just the unit tests.
test-integrationtest-integration Run just integration tests.
test-integration-clitest-integration-cli Run the test for the integration command line interface.
test-docker-pytest-docker-py Run the tests for Docker API client.
docs-testdocs-test Runs the documentation test build.
@@ -170,11 +163,11 @@ You can use the `TESTFLAGS` environment variable to run a single test. The flag's value is passed as arguments to the `go test` command. For example, from your local host you can run the `TestBuild` test with this command: - $ TESTFLAGS='-test.run ^TestBuild$' make test + $ TESTFLAGS='-test.run ^TestBuild$' make test To run the same test inside your Docker development container, you do this: - root@5f8630b873fe:/go/src/github.com/docker/docker# TESTFLAGS='-run ^TestBuild$' hack/make.sh + root@5f8630b873fe:/go/src/github.com/docker/docker# TESTFLAGS='-run ^TestBuild$' hack/make.sh ## If test under Boot2Docker fail do to space errors diff --git a/docs/sources/project/work-issue.md b/docs/sources/project/work-issue.md index 7175c11046..68d2ed750f 100644 --- a/docs/sources/project/work-issue.md +++ b/docs/sources/project/work-issue.md @@ -51,31 +51,31 @@ Follow this workflow as you work: 5. Format your source files correctly. - +
- + - + - +
File typeFile type How to format
.go.go

Format .go files using the gofmt command. For example, if you edited the `docker.go` file you would format the file - like this: -

-

$ gofmt -s -w file.go

-

- Most file editors have a plugin to format for you. Check your editor's - documentation. -

+ like this: +

+

$ gofmt -s -w file.go

+

+ Most file editors have a plugin to format for you. Check your editor's + documentation. +

.md and non-.go files.md and non-.go files Wrap lines to 80 characters.