►
From YouTube: Editing docs for style and topic type
Description
A walkthrough of how I began editing a docs page to implement clearer topic types and remove extraneous words.
More about topic types: https://docs.gitlab.com/ee/development/documentation/structure.html
More about GitLab style: https://docs.gitlab.com/ee/development/documentation/styleguide/
A
A
It
starts
with
some
prerequisites,
so
I
would
when
I
see
prerequisites,
I
think,
oh
a
bulleted
list
of
sort
of
things.
I
need
to
do
and
there's
some
text,
but
okay,
terminal
and
and
git
okay,
so
that's
probably
maybe
could
be
better
as
a
bulleted
list.
Okay
and
then
here's
how
to
open
a
terminal
and
install
git.
So
this
is
good
because
it's
kind
of
scannable,
good
scannable
and
then
this
one
has
a
few
more
steps,
so
probably
better
as
a
numbered
list.
It's
just
another
task
configure
get.
A
Then
it
starts
to
talk
about
authentication
methods,
so
this
is
where
I
kind
of
got
a
little
just
like
we're
starting
to
talk
about
https
we're
talking
about
ssh,
and
then
we
talk
about
ssh
and
https
again
and
sort
of
not
in
the
same
order
and
like
I'm
kind
of
thinking
like
oh,
why
aren't
these?
These
probably
could
be
combined,
somehow
I'm
not
sure
yet,
I'm
just
kind
of
looking
and
we're
explaining
authentication
methods.
A
But
if
you
look
over
here
in
the
nav
it
works,
then
we
start
talking
about
terminology
right
after
so
are
the
authentication
methods
terminology,
but
they
probably
know
what
authentication
is
or
you
know,
but
maybe
they're
not
sure
how
to
authenticate
so
we're
trying
to
teach
them
something.
But
it's
not
a
term,
I'm
not
sure.
Yet
what
I'm
going
to
do
with
this
so
that
I
just
kind
of
keep
going.
Okay,
there's
there's
some
terms,
looks
good.
A
You
know
we're
teaching
people
some
terms,
push
and
pull
okay,
and
then
then
we
get
into
some
tasks
set
up
a
repository,
okay
and
then
so
then
we
start
talking
about
https
and
ssh
again.
So
and
actually
so.
This
is
set
up
a
repository,
I'm
thinking.
Where
is
the
numbered
list
like
this?
It
seems
like
a
task
to
me,
so
it
should
have
a
numbered
list
and
then
same
with
clone.
Okay,
I'm
clone.
Now,
if
I'm,
if
I'm
a
customer,
do
I
do
I
read
this,
it
seems
to
have
some
commands
mixed
in.
A
Maybe
I'm
gonna
have
to
run
these
commands,
but
then
here
it
also
says
here's
the
commands,
but
I
kind
of
I
read
up
above
briefly
that
ssh
is
actually
the
recommended
one.
So
ssh
should
probably
be
first
and
sort
of.
I
can't
I
didn't
really
there's
no
easy
scanning
this.
I
kind
of
have
to
go
back
and
read
it
and
say:
okay.
Well,
there's
a
oh!
The
url
is
this,
but
I'm
going
to
they.
The
url
is
also
listed
here.
A
So
I
just
wanted
to
kind
of
that
was.
My
thought
process
was
like.
Oh
we're
talking
about
authentication
methods
here,
but
we're
also
talking
about
them
down
here.
Maybe
they
could
go
together
somehow,
as
long
as
I
still
have
nice
tasks,
so
this
is
kind
of
all
that
I've
been
looking
at.
Is
this
top
chunk
here,
and
so
I
went
through
it
a
bunch
this
morning
and
I
kind
of
came
up
with
a
structure,
so
I
wanted
to
show
you
what
that
was.
Let's
see,
so
you
can
sort
of
see
this.
A
A
Well,
so,
by
the
time,
if
somebody's
in
the
gitlab
documentation
and
they're
gonna
they're
ready
to
start
using
git
on
the
command
line,
they're
like
they've,
been
my
toaster
just
went
up.
They've
been
very
brave
and
they're
like
I'm
ready
to
start
using
git.
We
probably
don't
need
to
sell
them
on
the
fact
that
it's
designed
to
handle
everything
with
speed
and
efficiency,
it's
a
little
bit
of
just
wasting
their
time.
They're
like
I
just
want
to
start
using
git
like
I
get
it.
Okay,
so
get
labs
built
on
top
of
it.
A
Okay,
that's
kind
of
an
interesting
thing,
I'm
not
sure
what
built
on
top
means,
but
that's
okay,
maybe
they're
related
is
what
you're
saying
gitlab
has
a
powerful
user
interface.
Yes
and
we
do,
but
I
don't
know
again,
we
don't
know
if
we
have
to
sell
them
on
that.
You
can
do
a
great
amount
of
operations,
okay,
but
the
command
line
is
required
for
advanced
tasks.
Okay,
so
that's
kind
of
interesting.
We
need
you
need
git
for
advanced
or
the
command
line
good
to
know.
Okay,
oh
for
example.
A
If
you
need
to
fix,
merge
conflicts,
rebase
branches
use
it
from
the
command
line.
Then
there's
a
little
bit
describing
what
this
guide
is,
and
it's
called
like
self-referential
writing
when
you
write
about
this
guide.
So
if
you
can
it's
not
always
possible,
it's
a
really
hard
thing
to
kind
of
just
say
it's
hard
to
not
say
this
page
contains
or
this
tutorial
is
about.
A
But
if
you
can
just
try
to
get
right
into
the
content,
and
you
don't
have
to
say
this-
tells
you
how
to
start
using
git
from
the
command
line
that
says
references
and
bubble.
You
could
probably
just
get
rid
of
it.
They
know
I
came
to
this
page
because
I
want
to
learn
how
to
use
git
from
the
command
line.
A
Then
we
have
a
little
bit
of
like
marketing
text
and
that's
fine.
We've
been
asked
to
put
marketing
text
in
here
and
there.
So
that's
probably
what
that
is,
and
then
there's
this
note
about.
You
know
visualizing
git,
so
I
just
pared
it
down.
I
said
it's
an
open
source
version
control
system
get
something
built
on
top
of
it.
You
can
do
many
operations
directly.
However,
the
command
line
is
required
for
advanced
tasks,
and
then
I
kept
some
of
the
links
that
they
had.
A
A
Then
I
got
to
my
prereqs
so
remember
we
kind
of
had
a
little
bit
of
like
a
couple
sentences.
Instead,
I
just
said
these
are
things
you're
going
to
do
and
you
know
you
click
the
link
to
get
to
the
topic
itself,
so
you
open
a
terminal,
install
configure,
git
and
pick
a
repository
and
I'll
I'll
show
you
why
I
did
that,
but
so
we're
going
to
go
through
these
open
a
terminal,
great!
It's
like
a
it's
a
procedure.
A
A
So
here's
where
the
http,
so
you
know
we
didn't
talk
about
authentication.
Yet
we
didn't
talk
about
https.
We
didn't
talk
about
ssh,
so
here
we're
saying:
okay
clone
a
repository.
It
requires
you
to
add
credentials.
You
can
use
either
an
ssh
as
recommended,
and
I
know
how
the
writers
are
saying:
that's
passive
voice
and
that's
for
another
day.
I
think
I'll,
probably
change
this
to
gitlab
recommends
ssh,
but
that's
a
that's
a
discussion
for
another
day,
how
we
say
what
we
recommend
anyway,
it's
two
procedures.
Now,
that's
it!
A
It's
use
this
when
you
want
to
authenticate
only
one
time
use
this
when
you
want
to
authenticate
each
time
it's
like
well,
who
wants
to
do
that?
Probably
maybe
not
many
people,
but
this
is
the
information
that
was
over
on
the
other
page
in
sort
of
various
areas
like
it
was
enter
your
credentials.
Every
time
you
perform
an
operation,
git
lab
no
longer
requests
your
credentials,
and
it's
like.
Let's,
we
don't
want
to
write
from
what
git
lab
kind
of
wants
or
doesn't
want
we're
just
like
hey.
What
is
it
for
me?
A
Oh,
I
don't
have
to
enter
my
credentials.
Every
time
awesome
authenticate
only
one
authenticate
one
time.
Actually
it
should
be
one
authenticate
only
one
time,
only
not
perfect,
just
moving
toward
it
anyway,
so
clone
repository
clone
with
ssh,
and
these
are
numbered
lists-
you
just
go
straight
through
it
and
then
you've
cloned
it
and
all
that
additional
sort
of
back
and
forth
between
what
is
authentication
how
to
authenticate
into
it's
like
no.
Now
it's
just
pick
one
or
the
other
and
here's
the
instructions
for
how
to
do
it.