Skip to content

Commit

Permalink
Docs contributor guide: added links to subtopics on left-side menu (d…
Browse files Browse the repository at this point in the history
…ocker#5246)

* Docs contributor guide: added links to subtopics on right side menu

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* copyedits

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* more copyedits

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* added back in some of the community pages by request

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* added other ways to contribute to left side menu

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* copyedits to contributor home page

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* added links to Docker Community pages on GitHub

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* merged ways to contribute, made moby an include, re-org for tocs

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed TOC yaml

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* fixed on-page links on community page

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
  • Loading branch information
londoncalling committed Nov 9, 2017
1 parent 6ccbd7f commit 92bd5b3
Show file tree
Hide file tree
Showing 6 changed files with 201 additions and 20 deletions.
21 changes: 21 additions & 0 deletions _data/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,27 @@ guides:
section:
- path: /opensource/
title: Contribute to the documentation
- path: /test/
title: Learn docs components and formats
- path: https://github.com/docker/docker.github.io/blob/master/README.md
title: README for docker.github.io
- path: /opensource/ways/
title: Other ways to contribute
- sectiontitle: Practice workflow with Kitematic
section:
- path: /opensource/kitematic/get_started/
title: Get started
- path: /opensource/kitematic/find_issue/
title: Find an issue
- path: /opensource/kitematic/set_up_dev/
title: Set up for Kitematic development
- path: /opensource/kitematic/work_issue/
title: Develop in Kitematic (work on an issue)
- path: /opensource/kitematic/create_pr/
title: Create a pull request (PR)
- path: /opensource/kitematic/next_steps/
title: Where to learn more

- sectiontitle:
section:
- path: /docsarchive/
Expand Down
16 changes: 16 additions & 0 deletions _includes/content/moby.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Docker [introduced the open source Moby
project](https://blog.docker.com/2017/04/introducing-the-moby-project/) to
further promote collaboration, experimentation, and development of
container-based systems in the broader community. Moby is a library of
containerized components, a framework for assembling components into a container
platform, and tools to build, test, and deploy artifacts. It included a
reference assembly, which is the open base for the Docker platform.

You can read about the Moby project, the open framework, components, and
relationship of Docker to Moby at [mobyproject.org](https://mobyproject.org/).

The Moby project lives [here](https://github.com/moby/moby).

See [Contribute to the Moby
project](https://github.com/moby/moby/blob/master/CONTRIBUTING.md) to learn how
to help work on the codebase.
28 changes: 9 additions & 19 deletions opensource/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,6 @@ redirect_from:
- /opensource/governance/dgab-info/
- /opensource/governance/board-profiles/
- /opensource/governance/conduct-code/
- /opensource/ways/
- /opensource/ways/meetups/
- /opensource/ways/issues/
- /opensource/ways/community/
- /opensource/ways/test/

---

Expand Down Expand Up @@ -99,24 +94,19 @@ To learn more about working on the documentation, see these topics:
published site. It explains how to use Docs components, resources, and
formats, and gives us a way to test and demo them.

## Looking for Moby?
## Looking for meetups and Docker Community?

Docker [introduced the open source Moby
project](https://blog.docker.com/2017/04/introducing-the-moby-project/) to
further promote collaboration, experimentation, and development of
container-based systems in the broader community. Moby is a library of
containerized components, a framework for assembling components into a container
platform, and tools to build, test, and deploy artifacts. It included a
reference assembly, which is the open base for the Docker platform.
Go to the [Docker Community GitHub
repository](https://github.com/docker/community/blob/master/README.md){:
target="_blank" class="_"} for resources and information on the community.

You can read about the Moby project, the open framework, components, and
relationship of Docker to Moby at [mobyproject.org](https://mobyproject.org/).
The topics in this guide on [Other ways to contribute](/opensource/ways/)
provide some additional information, but it's likely you'll find the community
information you are looking for on the GitHub repository.

The Moby project lives [here](https://github.com/moby/moby).
## Looking for Moby?

See [Contribute to the Moby
project](https://github.com/moby/moby/blob/master/CONTRIBUTING.md) to learn how
to help work on the codebase.
{% include content/moby.md %}

## Legacy fun and practice

Expand Down
2 changes: 1 addition & 1 deletion opensource/kitematic/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Introduces Kitematic contribute topics and tour
keywords: Kitematic, open source, contribute, contributor, tour, issue, review
title: Contribute to Kitematic
title: Practice contribution workflow with Kitematic
---

* [Get started](get_started.md)
Expand Down
134 changes: 134 additions & 0 deletions opensource/ways.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
---
description: How to support the Docker community, organize meetups, or become a mentor
keywords: meetups, community, mentoring
title: Other ways to contribute
redirect_from:
- /opensource/ways/community/
- /opensource/ways/meetups/
- /opensource/ways/issues/
- /opensource/ways/test/
---

Beyond the documentation contributions we cover here, there are many other ways
to contribute to Docker. Whether you are just getting started or are expert in
your field, you have a unique perspective that is a valuable resource to share
with others. The Docker community, meetups, mentoring, and open source projects
all need your participation, ideas, feedback, and vision.

* [Organize a Docker meetup](#organize-a-docker-meetup)
* [Learn about the Docker Community](#learn-about-the-docker-community)
* [Contribute to the Moby open source project](#contribute-to-the-moby-open-source-project)

## Organize a Docker meetup

Anyone interested in Docker can become an active member of the Docker community
by becoming a co-organizer of a Docker Meetup group.

If a Meetup group does not already exist in your area and you are willing to
start a new one, the best way to proceed is to contact us so that we can create
it for you. We will always agree to create a new Docker Meetup group as long as
it makes sense geographically speaking.

If you have already created a Docker Meetup group that is fine, we will simply
ask you to add us as a co-organizer so that we can ensure a consistent support
to the group in terms of community and Meetup management.

Before contacting us to create a new Docker Meetup Group, take a look at our
Meetup Groups page to make sure a group does not already exist in the area.

### Get started putting on a Docker Meetup

Now that you are a co-organizer of a Docker Meetup Group, here are a few tips and
suggestions to help you get started:

* Attend similar DevOps or Developers Meetups to gain experience and gauge interest in Docker
* Contact other people interested in Docker to help you organize and promote future Meetups
* Research High-Tech companies in your area willing to host a Docker Meetup event
* Research what would be the best date(s) to schedule the Meetups based on availabilities with regard to competing events in the area and other calendar imperative
* Research what are the topic of interest to your audience prior to set an agenda for the meetup
* Pay attention to the Meetup page aesthetics, add logos and pictures, invite members to leave comments and reply to these comments
* Promote the event on social media and make sure that the list of keywords is well define if you have created the Docker Meetup Group on your own

### How Docker can help you organize

We can support the co-organizers of the Docker Meetup Groups based on their specific needs. For instance, we might / will be able to:

* Send you Docker T-shirts and stickers
* Put you in contact with other people interested in being a co-organizer of a Docker Meetup group, and which are in the same area
* Put you in contact with companies willing to host a Docker Meetup in your area
* Introduce you to people willing to give a lightning talk about Docker
* Promote your Docker Group on Docker.com, Docker Weekly and Social Media
Hackday Picture

### Host a Docker meetup at your location

![Meetup](../images/docker-friends.png)

### Want to host a Docker Meetup?

We are always looking for new office space to host Docker Meetups. If your
company is willing to host a Docker Meetup, please contact us by email at
meetup@docker.com. Previous Docker Meetups have been hosted by companies such
as Rackspace, Twitter, MongoDB, BrightCove, DigitalOcean, Viadeo and Edmodo.
#### How many attendees?

The company hosting the event fixes the number of attendees depending on their
office size and availability. This number usually varies between 30 and 200.

#### How long is a Docker Meetup?

Once again, each company hosting the event decides when does the meetup start,
and how long it lasts. Usual meetups tend to last 2 hours, and start between
4pm and 6pm.

## Learn about the Docker Community

Go to the **[Docker Community GitHub
repository](https://github.com/docker/community/blob/master/README.md){:
target="_blank" class="_"}** for
resources and information on the community. Those pages are the most
up-to-date for finding out about the community and making connections.

The topics below provide some additional links, but it's likely that everything
you need will be on the GitHub repository.

### Become a Mentor

With millions of Docker users all over the world, there's always someone who
needs a helping hand. Like many open source projects, the Docker project relies
on community support channels like forums, IRC, and StackOverflow. You should
contribute mentoring if you have good knowledge of:

* how open source projects run
* using Docker in some particular domain (for example, testing or deployment)
* using Git, Go, GitHub, IRC, or other common tools

Also, choose mentoring if you like to be happy. Studies show that [helping others](http://www.huffingtonpost.com/2013/09/03/five-minute-favor-adam-rifkin_n_3805090.html){: target="_blank" class="_"} is a great way to
boost your own well being.


### Docker users

Docker users are people using Docker in their daily work. To help Docker users, visit:

* the [Docker Community Forum](https://forums.docker.com/){: target="_blank" class="_"}
* the `#docker` channel on Freenode IRC
* [StackOverflow](http://stackoverflow.com/search?tab=newest&q=docker){: target="_blank" class="_"}

You can also check the lists of [open issues on the Docker docs](https://github.com/docker/docker.github.io/issues){: target="_blank" class="_"} and [open issues on the Moby project](https://github.com/moby/moby/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fquestion+-label%3Astatus%2Fclaimed+-label%3Astatus%2Fassigned+no%3Aassignee){: target="_blank" class="_"}.


### Docker contributors

Docker contributors are people like you, interested in the open source projects
and product documentation. Contributors may need help with IRC, Go programming,
Markdown, or with other aspects of contributing. To help Docker contributors,
visit:

* the [Docker Gitter IM](https://gitter.im/docker/docker){: target="_blank" class="_"} room
* the [Google group](https://groups.google.com/forum/#!forum/docker-dev){: target="_blank" class="_"}
* the `#docker-dev` channel on Freenode IRC

## Contribute to the Moby open source project

{% include content/moby.md %}
20 changes: 20 additions & 0 deletions test.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,26 @@ hide_from_sitemap: true
toc_min: 1
---

Welcome to the Docker documentation test page!

This is a demo of components, tags, styles, tools, and strategies we use for the
docs. We explain the code behind the published page and demo the effects. So, if
you want to see, for example, how admonitions and notes are coded in markdown,
read the section on [Admonitions (notes)](/test/#admonitions-notes) on the web
published page and study the pre-processed `test.md` to see how they are
implemented. The Docker documentation team uses this page as "note to self"
reminders. Since we invite docs suggestions and contributions from the
community, we've always made the test page generally available.

If you want to understand how something in the docs is coded, use this page is
as a resource.

If, in the course of making docs updates and suggestions, you develop a new
strategy or component for the docs, feel free to add a demo and explanation to
this test page and submit a PR for it so we can review and discuss it.

Cool? Let's dive in!

# Heading 1

Most pages don't actually have a H1 heading. The page title from the metadata is
Expand Down

0 comments on commit 92bd5b3

Please sign in to comment.