►
From YouTube: How we’re working with the community to build docs as an interface for code - GitHub Universe 2020
Description
Presented by Kath Korevec, Senior Director, Product, GitHub
Just like code, docs shouldn't be static. They need to evolve and respond to the changes in the developer world every day. That's why we believe that GitHub Docs are better when they're used in the open—with the people who are building the features and those who are using them all participating in tandem. In this talk, you'll hear about why and how we took our docs public, and the lessons we learned along the way.
For more from GitHub Universe 2020, visit https://githubuniverse.com
As always, feel free to leave us a comment below and don't forget to subscribe: http://bit.ly/subgithub
Thanks!
Connect with us.
Facebook: http://fb.com/github
Twitter: http://twitter.com/github
LinkedIn: http://linkedin.com/company/github
About GitHub
GitHub is the best place to share code with friends, co-workers, classmates, and complete strangers. Millions of people use GitHub to build amazing things together. For more info, go to http://github.com
A
All
right
that
was
awesome
and
yeah,
so
my
name
is
kath
and
I
work
on
the
product
team
at
github,
where
I'm
focused
on
working
on
our
documentation,
and
I'm
really
excited
to
be
here
today
to
talk
with
you
about
some
of
the
updates
that
we've
been
making
to
the
docs
and
if
you've
been
following
along
you've,
probably
seen
some
of
the
stuff
that
we've
that
we've
been
working
on.
But
really
this
is
about
where
we're
taking
documentation
with
the
help
of
our
community.
A
So
kind
of
to
set
your
expectations,
I
just
want
to
talk
through
a
little
bit
of
the
goals
that
we
have
for
for
today's
session.
We're
going
to
get
to
know
kind
of
why
we
open
source
documentation
and
we're
also
going
to
learn
about
how
you
can
make
contributions
to
the
github
documentation
itself
at
get
that
slash,
github
docs
and
then
we're
going
to
discover
where
we're
taking
documentation.
And
hopefully
you
feel
a
little
bit
inspired.
A
And
so
we've
been
doing
a
lot
to
update
github
documentation
this
year,
so
yeah
if
you've
been
following
along
you've,
likely
noticed
that
we've
been
iterating
and
updating
a
whole
bunch
of
stuff
within
our
get
our
github
actions
documentation
and
we
actually
just
released
two
brand
new
pages
for
github
education
and
github
discussions.
And
so
you
can.
A
They
present
as
a
lot
of
text
to
work
through,
and
so
really.
The
only
way
to
interact
with
them
is
to
go
and
read
them,
maybe
side
by
side
with
another
tab
that
you're
working
in
but
you're
still
just
reading
through
them,
and
we
know
people
learn
in
many
different
ways
and
so
on
the
docs
team.
We're
naturally
experimenting
with
updating
the
documentation
to
be
more
inclusive
or
to
have
more
in
interactive
features.
You
can
actually
see
something
that
we
have
been
experimenting
with.
A
One
of
the
demos
that
that
we've
been
really
liking
is
over
on
playground.herokuapp.com.
You
can
see
some
of
the
interactive
elements
that
we're
playing
with.
We
do
that
there
kind
of
before
we
migrate
things
into
the
larger
docs
set,
so
we
can
kind
of
play
around
with
them
and
make
sure
the
interactions
are
correct,
because
we
want
everything
to
be
very
precise
and
up
to
date
and
so
go
over
there
to
check
out
things
like
we're
at
like
an
editor
experience
that
we're
adding
and
videos
etc.
A
But
just
like
code
docs
really
should
not
never
be
static,
products
always
change
and
we're
always
coming
to
understand
them
through
many
different
kinds
of
lenses
and
a
lot
of
different
experiences
too.
So
on
the
docs
team
at
github.
We're
constantly
updating
the
docs
to
make
sure
that
they're
accurate
and
this
year
we're
taking
that
that,
even
like
one
step
further
to
create
this
really
living
breathing
application.
That's
a
reflection
of
the
content,
the
community
and
the
tools
that
we're
building
at
github
as
we
shift
new
things
and
github's
products.
A
A
Some
of
them
are
new
to
git
entirely
and
we
want
to
understand
and
incorporate
their
perspectives
into
all
of
the
different
so
that
we
reach
all
the
different
types
of
developers,
so
whether
you're
new
to
programming
or
new,
to
github
or
you've,
just
you're
just
new
to
one
of
the
products
that
we've
recently
shipped
as
developers,
we're
always
learning
something
different
and
whether
it's
a
new
language
or
it's
a
new
github
project
or
new
github
features.
We
want
to
get
that
perspective
baked
in.
A
I
know
for
me
when
I
am
when
I'm
when
I'm
an
expert
in
something
I
explain
it
in
a
totally
different
way
than
if
I'm
new
to
something,
and
so
we
we
see
people.
We
see
developers
of
many
different
walks
coming
to
github
documentation.
So
we
want
to
provide
that
perspective
for
all
of
those
folks
in
our
documentation
and
really
the
goal
is
docs
should
be
simple
and
easy
to
use.
A
So
we
did
this
this
past
october
and
I'm
really
excited
to
talk
with
you
about
how
that's
been
going,
and
this
is
from
the
moment
we
actually
flipped
the
switch.
It
was
just
before
9
00
a.m
and
on.
I
think
it
was
like
october
at
the
beginning
of
october.
We
did
this
for
hacktoberfest
and
we
got
this
notification
in
our
slack
channel.
So
there's
a
little
bit
of
a
celebratory
moment,
mona
timed
into
it
was
really
pretty
fun
and
what
this
meant
for
us
was
not
just
that.
A
So
one
of
the
examples
that
I
really
love
from
early
on
in
our
open
source
journey
is
this
guide,
and
this
was
written
by
chrissy,
lamarr,
she's,
a
powershell
developer
and
the
maintainer
of
dba
tools
and
I'll
tell
you
a
little
secret.
We
don't
have
anybody
on
the
docs
team
that
specializes
in
powershell,
but
we
do
have
developers
in
our
community
who
really
want
to
know
how
they
can
create
ci,
workflows
and
test
their
powershell
project.
A
So
I
think
it
was
on
day
one
chrissy
got
really
excited
and
started
to
write
out
this
guide,
and
she-
and
I
got
to
talking-
and
I
was
like
you
know
what
we
should
just
do
this,
and
it
was
great
because
she
knows
a
ton
about
powershell
and
a
lot
about
github
actions,
and
so
she
really
got
to
bring
that
expertise.
We
collaborated
with
her
on
this
so
that
she
could
help
with.
So
we
could
help
her
with
content
styles
and
contributing
and
and
create
this
whole
new
article
for
people.
A
So
we
could
reach
even
more
folks
through
this
tutorial
who
are
in
the
powershell
community.
Even
before
we
shipped
this,
we
knew
that
it
was
going
to
be
successful
and
people
wanted
it
because
we
saw
people
using
it
as
a
pr
before
we
even
merged
it
into
the
main
branch
and
open
sourcing.
Really
what
it
does
is.
A
It
lets
us
plug
some
of
these
gaps
that
we
have
in
our
documentation
by
inviting
experts
in
like
chrissy
to
participate
and
working
with
her
to
help
tell
this
story
and
write
the
tutorials
themselves,
and
if
you
go
to
github
doc,
executive.com
actions
you'll,
see
chrissy's,
tutorial,
featured
and
and
called
out
in
on
that
page.
So
you
can
go
and
learn
how
to
build
and
test
with
powershell.
A
So
we
open
source
docs.github.com
in
two
main
parts
or
sorry
main
parts.
We
open
source,
the
content
itself
and
the
application
and
the
content
is
all
in
markdown
and
uses
liquid,
rendering
the
app
that
powers.
This
is
mostly
node.js
and
we've
recently
started
to
experiment
with
adding
react
components
to
it
to
help
it
help,
make
it
more
interactive,
and
so
you'll
see
some
of
that
stuff
coming
soon,
and
you
can
check
out
that
demo
for
it
on
on
that
url
that
I
mentioned
before
doc's
playground.
A
A
So
this
this
project
has
been
going
on
for
quite
a
while,
and
this
summer
we
decided
to
kind
of
crank
it
up.
So
we
could
hit
our
milestone
of
being
able
to
open
source
in
october
with
hacktoberfest,
but
we
also
had
that
didn't.
That
was
that
was
definitely
not
without
its
challenges.
And
so,
if
you
are,
you
know
if
you're
taking
a
project
public
that
has
already
been
established.
A
A
We
had
several
different
challenges
along
the
way
and
I'm
going
to
talk
about
three
of
them,
and
this
first
one
is
that
we
actually
on
the
documentation
team.
We
work
in
public
and
we
work
in
private
and
that's
really
because,
while
we
do
work
against
our
our
product
roadmap
and
a
lot
goes
into
our
product
roadmap,
that
that
you
all
can
see,
there's
a
lot
of
detail
that
happens
in
the
documentation
and
about
the
features
and
how
to
use
them,
etc.
A
So
before
we
launch,
we
actually
want
to
work
on
all
of
those
that
documentation
in
private,
and
that
happens
on
a
repository
on
an
internal
repository,
and
then
we
also
maintain
our
external
repository.
So
what
this
does
you
can
imagine?
We've
got
you
know
maintaining
that
all
of
this
stuff
manually
could
get
really
tricky.
So
we
we
use
two
different
things
to
help
us
with
this.
We
use
a
github
action
that
is
called
it's
actually
open
source.
A
We
have.
We
have
over
40
github
actions
in
our
docs
repo,
and
many
of
them
are
used
for
ci
cd.
So
there's
a
lot
going
on
here.
We've
got
internal
contributions
to
our
internal
repository,
that's
synced!
Every
15
minutes
we've
got
open
source
contributions
that
are
happening,
and
we
have
lots
of
conversations
that
are
going
on
with
all
of
this
content.
Our
content
set
is
really
large
and
so
there's
a
lot
to
pay
attention
to
when
you
open
up
a
pr
for
for
the
docs
for
the
docs
repository.
A
Sorry
about
that,
I
think
you
could
probably
hear
my
dogs.
I've
got
a
clique
and
an
australian
shepherd
and
they
love
everything
to
do
with
open
source
documentation,
so
they
might
chime
in.
But
when
you
open
up
a
pr
for
this
you're,
you
you,
you
know,
you
want
all
of
your
checks
to
pass,
and
so
we
do
lots
of
there's
lots
of
stuff
going
on.
We
do
what
a
lot
of
developers
do,
which
is
keep
that
pr
open
and
kind
of
babysit
it.
A
While
we
wait
for
all
those
checks,
checks
to
pass
and
then
click
the
manual
merge
button,
but
now
with
auto
merge,
we
can
actually
go
about
doing
our
doing
our
business.
Go
into
onto
other
projects,
open
up
other
pr's
and,
as
neha
said,
let
the
robots
deal
with
actually
automatically
merging
that
into
the
main
branch
and
then
finally,
one
of
the
things
that
is
really
important
to
us
on
documentation,
and
this
is
actually
baked
into
all
of
our
content.
A
Styles
and
our
content
architecture
and
how
we
write
our
documentation
is
translations,
and
so
our
docs
are
available
in
five
different
languages.
English,
chinese,
japanese,
spanish
and
portuguese,
which
brian
would
brian
would
love
to
know
because
he's
learning
a
lot
about
portuguese
this
whole
week.
But
today
we
use
a
tool
called
crowden
to
help
us
translate
all
of
our
content
and
keep
us
updated
as
we
make
changes
to
the
documentation.
A
So
we
update,
we
translate
documentation
as
it
gets
inserted
brand
new
into
the
code
base,
but
then
every
time
that
documentation
changes,
crowd
and
manages
that
whole
entire
process
and
lets
people
know
when
there
are
changes
or
when
there
are
new
contributions
that
need
to
be
translated
and
right
now
we
don't
have
a
way
to
accept
open
source
contributions
to
our
open
source
repository
for
these
translation
files-
and
this
is
because
you
know
we're
we're
us
on
the
docs
team.
We
don't
have
all
of
the.
A
We
don't
have
a
lot
of
experts
in
all
of
these
different
languages
to
be
able
to
review
and
verify
that
those
translations
were
actually
correct
and
accurate.
But
we
do
really
want
to
make
it
possible
for
people
to
update
language
our
language
files
in
the
open
source
repository
and
also
continue
to
work
with
crowdin
to
manage
all
of
these.
These
translation
projects
so
we're
working
on
this
a
way
to
offer
open
source
contributions
to
our
language
files
coming
in
the
next
year.
A
And
right
now
there
are,
there
are
lots
of
different
ways
to
contribute
to
our
open
source,
documentation
and
three
of
them
that
we
really
love.
Are
these
three.
You
can
that
it's
basically,
you
can
contribute
with
small
bug
fixes
and
those
are
going
to
be
things
like
you
know,
typos
or
a
small
bug
in
the
code
base.
A
So
I'm
going
to
show
you
something
that
we
recently
added
to
the
github
actions
page,
which
is
code
examples.
So
I
know
when
I'm
learning
a
new
language
or
about
a
new
feature,
I
like
to
turn
to
other
developers
and
see
how
they're
using
it-
and
here
you
see
me
navigating
through
a
all
of
the
different
code
examples
and
then
these
link
directly
to
github
we're
actually
using
sarah
drezner's
awesome
actions
list.
It's
been
mentioned.
Several
times
this
whole
entire
week,
it's
a
really
great
resource.
A
So
if
you
want
to
join,
if
you
want
to
get
started
and
join
our
community
right
now,
you
totally
can
and
you
can
get
started
at
github.com,
github,
slash,
docs
and
go
there
and
and
contributing
is
super
easy.
Our
docs
team
has
been
standing
by
all
week.
Answering
questions.
We've
been
answering
lots
of
questions
in
our
issues
and
responding
to
pull
requests,
but
you
can
go
there
and
open
up
an
issue.
You
can
pick
up
an
issue
and
open
up
a
pr
just
and
get
started
super
fast.
A
A
Documentation
is
so
important
to
how
people
understand
a
product
or
a
new
technology
and
how
people
understand
how
github
works,
and
we
really
want
to
make
our
documentation
a
lot
better
and
improve
it,
and
we
need
your
feedback
so
definitely
go
there
open
up
a
discussion.
Ask
a
question:
give
us
a
lot
of
feedback
on
that
or
you
can
just
reach
out
to
me
directly.
I
am
at
some
soca
on
twitter,
also
on
github,
so
yeah.