Skip to content

Commit 92bd5b3

Browse files
Docs contributor guide: added links to subtopics on left-side menu (docker#5246)
* Docs contributor guide: added links to subtopics on right side menu Signed-off-by: Victoria Bialas <[email protected]> * copyedits Signed-off-by: Victoria Bialas <[email protected]> * more copyedits Signed-off-by: Victoria Bialas <[email protected]> * added back in some of the community pages by request Signed-off-by: Victoria Bialas <[email protected]> * added other ways to contribute to left side menu Signed-off-by: Victoria Bialas <[email protected]> * copyedits to contributor home page Signed-off-by: Victoria Bialas <[email protected]> * added links to Docker Community pages on GitHub Signed-off-by: Victoria Bialas <[email protected]> * merged ways to contribute, made moby an include, re-org for tocs Signed-off-by: Victoria Bialas <[email protected]> * fixed TOC yaml Signed-off-by: Victoria Bialas <[email protected]> * fixed on-page links on community page Signed-off-by: Victoria Bialas <[email protected]>
1 parent 6ccbd7f commit 92bd5b3

6 files changed

Lines changed: 201 additions & 20 deletions

File tree

_data/toc.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -470,6 +470,27 @@ guides:
470470
section:
471471
- path: /opensource/
472472
title: Contribute to the documentation
473+
- path: /test/
474+
title: Learn docs components and formats
475+
- path: https://github.com/docker/docker.github.io/blob/master/README.md
476+
title: README for docker.github.io
477+
- path: /opensource/ways/
478+
title: Other ways to contribute
479+
- sectiontitle: Practice workflow with Kitematic
480+
section:
481+
- path: /opensource/kitematic/get_started/
482+
title: Get started
483+
- path: /opensource/kitematic/find_issue/
484+
title: Find an issue
485+
- path: /opensource/kitematic/set_up_dev/
486+
title: Set up for Kitematic development
487+
- path: /opensource/kitematic/work_issue/
488+
title: Develop in Kitematic (work on an issue)
489+
- path: /opensource/kitematic/create_pr/
490+
title: Create a pull request (PR)
491+
- path: /opensource/kitematic/next_steps/
492+
title: Where to learn more
493+
473494
- sectiontitle:
474495
section:
475496
- path: /docsarchive/

_includes/content/moby.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Docker [introduced the open source Moby
2+
project](https://blog.docker.com/2017/04/introducing-the-moby-project/) to
3+
further promote collaboration, experimentation, and development of
4+
container-based systems in the broader community. Moby is a library of
5+
containerized components, a framework for assembling components into a container
6+
platform, and tools to build, test, and deploy artifacts. It included a
7+
reference assembly, which is the open base for the Docker platform.
8+
9+
You can read about the Moby project, the open framework, components, and
10+
relationship of Docker to Moby at [mobyproject.org](https://mobyproject.org/).
11+
12+
The Moby project lives [here](https://github.com/moby/moby).
13+
14+
See [Contribute to the Moby
15+
project](https://github.com/moby/moby/blob/master/CONTRIBUTING.md) to learn how
16+
to help work on the codebase.

opensource/index.md

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,6 @@ redirect_from:
2929
- /opensource/governance/dgab-info/
3030
- /opensource/governance/board-profiles/
3131
- /opensource/governance/conduct-code/
32-
- /opensource/ways/
33-
- /opensource/ways/meetups/
34-
- /opensource/ways/issues/
35-
- /opensource/ways/community/
36-
- /opensource/ways/test/
3732

3833
---
3934

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

102-
## Looking for Moby?
97+
## Looking for meetups and Docker Community?
10398

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

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

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

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

121111
## Legacy fun and practice
122112

opensource/kitematic/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
description: Introduces Kitematic contribute topics and tour
33
keywords: Kitematic, open source, contribute, contributor, tour, issue, review
4-
title: Contribute to Kitematic
4+
title: Practice contribution workflow with Kitematic
55
---
66

77
* [Get started](get_started.md)

opensource/ways.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
description: How to support the Docker community, organize meetups, or become a mentor
3+
keywords: meetups, community, mentoring
4+
title: Other ways to contribute
5+
redirect_from:
6+
- /opensource/ways/community/
7+
- /opensource/ways/meetups/
8+
- /opensource/ways/issues/
9+
- /opensource/ways/test/
10+
---
11+
12+
Beyond the documentation contributions we cover here, there are many other ways
13+
to contribute to Docker. Whether you are just getting started or are expert in
14+
your field, you have a unique perspective that is a valuable resource to share
15+
with others. The Docker community, meetups, mentoring, and open source projects
16+
all need your participation, ideas, feedback, and vision.
17+
18+
* [Organize a Docker meetup](#organize-a-docker-meetup)
19+
* [Learn about the Docker Community](#learn-about-the-docker-community)
20+
* [Contribute to the Moby open source project](#contribute-to-the-moby-open-source-project)
21+
22+
## Organize a Docker meetup
23+
24+
Anyone interested in Docker can become an active member of the Docker community
25+
by becoming a co-organizer of a Docker Meetup group.
26+
27+
If a Meetup group does not already exist in your area and you are willing to
28+
start a new one, the best way to proceed is to contact us so that we can create
29+
it for you. We will always agree to create a new Docker Meetup group as long as
30+
it makes sense geographically speaking.
31+
32+
If you have already created a Docker Meetup group that is fine, we will simply
33+
ask you to add us as a co-organizer so that we can ensure a consistent support
34+
to the group in terms of community and Meetup management.
35+
36+
Before contacting us to create a new Docker Meetup Group, take a look at our
37+
Meetup Groups page to make sure a group does not already exist in the area.
38+
39+
### Get started putting on a Docker Meetup
40+
41+
Now that you are a co-organizer of a Docker Meetup Group, here are a few tips and
42+
suggestions to help you get started:
43+
44+
* Attend similar DevOps or Developers Meetups to gain experience and gauge interest in Docker
45+
* Contact other people interested in Docker to help you organize and promote future Meetups
46+
* Research High-Tech companies in your area willing to host a Docker Meetup event
47+
* 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
48+
* Research what are the topic of interest to your audience prior to set an agenda for the meetup
49+
* Pay attention to the Meetup page aesthetics, add logos and pictures, invite members to leave comments and reply to these comments
50+
* 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
51+
52+
### How Docker can help you organize
53+
54+
We can support the co-organizers of the Docker Meetup Groups based on their specific needs. For instance, we might / will be able to:
55+
56+
* Send you Docker T-shirts and stickers
57+
* 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
58+
* Put you in contact with companies willing to host a Docker Meetup in your area
59+
* Introduce you to people willing to give a lightning talk about Docker
60+
* Promote your Docker Group on Docker.com, Docker Weekly and Social Media
61+
Hackday Picture
62+
63+
### Host a Docker meetup at your location
64+
65+
![Meetup](../images/docker-friends.png)
66+
67+
### Want to host a Docker Meetup?
68+
69+
We are always looking for new office space to host Docker Meetups. If your
70+
company is willing to host a Docker Meetup, please contact us by email at
71+
[email protected]. Previous Docker Meetups have been hosted by companies such
72+
as Rackspace, Twitter, MongoDB, BrightCove, DigitalOcean, Viadeo and Edmodo.
73+
#### How many attendees?
74+
75+
The company hosting the event fixes the number of attendees depending on their
76+
office size and availability. This number usually varies between 30 and 200.
77+
78+
#### How long is a Docker Meetup?
79+
80+
Once again, each company hosting the event decides when does the meetup start,
81+
and how long it lasts. Usual meetups tend to last 2 hours, and start between
82+
4pm and 6pm.
83+
84+
## Learn about the Docker Community
85+
86+
Go to the **[Docker Community GitHub
87+
repository](https://github.com/docker/community/blob/master/README.md){:
88+
target="_blank" class="_"}** for
89+
resources and information on the community. Those pages are the most
90+
up-to-date for finding out about the community and making connections.
91+
92+
The topics below provide some additional links, but it's likely that everything
93+
you need will be on the GitHub repository.
94+
95+
### Become a Mentor
96+
97+
With millions of Docker users all over the world, there's always someone who
98+
needs a helping hand. Like many open source projects, the Docker project relies
99+
on community support channels like forums, IRC, and StackOverflow. You should
100+
contribute mentoring if you have good knowledge of:
101+
102+
* how open source projects run
103+
* using Docker in some particular domain (for example, testing or deployment)
104+
* using Git, Go, GitHub, IRC, or other common tools
105+
106+
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
107+
boost your own well being.
108+
109+
110+
### Docker users
111+
112+
Docker users are people using Docker in their daily work. To help Docker users, visit:
113+
114+
* the [Docker Community Forum](https://forums.docker.com/){: target="_blank" class="_"}
115+
* the `#docker` channel on Freenode IRC
116+
* [StackOverflow](http://stackoverflow.com/search?tab=newest&q=docker){: target="_blank" class="_"}
117+
118+
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="_"}.
119+
120+
121+
### Docker contributors
122+
123+
Docker contributors are people like you, interested in the open source projects
124+
and product documentation. Contributors may need help with IRC, Go programming,
125+
Markdown, or with other aspects of contributing. To help Docker contributors,
126+
visit:
127+
128+
* the [Docker Gitter IM](https://gitter.im/docker/docker){: target="_blank" class="_"} room
129+
* the [Google group](https://groups.google.com/forum/#!forum/docker-dev){: target="_blank" class="_"}
130+
* the `#docker-dev` channel on Freenode IRC
131+
132+
## Contribute to the Moby open source project
133+
134+
{% include content/moby.md %}

test.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,26 @@ hide_from_sitemap: true
55
toc_min: 1
66
---
77

8+
Welcome to the Docker documentation test page!
9+
10+
This is a demo of components, tags, styles, tools, and strategies we use for the
11+
docs. We explain the code behind the published page and demo the effects. So, if
12+
you want to see, for example, how admonitions and notes are coded in markdown,
13+
read the section on [Admonitions (notes)](/test/#admonitions-notes) on the web
14+
published page and study the pre-processed `test.md` to see how they are
15+
implemented. The Docker documentation team uses this page as "note to self"
16+
reminders. Since we invite docs suggestions and contributions from the
17+
community, we've always made the test page generally available.
18+
19+
If you want to understand how something in the docs is coded, use this page is
20+
as a resource.
21+
22+
If, in the course of making docs updates and suggestions, you develop a new
23+
strategy or component for the docs, feel free to add a demo and explanation to
24+
this test page and submit a PR for it so we can review and discuss it.
25+
26+
Cool? Let's dive in!
27+
828
# Heading 1
929

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

0 commit comments

Comments
 (0)