►
Description
The Keptn documentation is maturing along with the software. Learn about the incremental improvements we have made, what we are working on, and how you can get involved if you are interested.
This is a presentation for the Keptn Community Day on October 25th. Presented by Meg McRoberts, a Keptn contributor and Developer Experience Lead at Dynatrace.
A
Kept
in
documentation
is
maturing
along
with
the
captain
software.
You
may
have
noticed
some
changes
in
the
documentation
and
heard
rumors
of
changes
that
are
planned.
My
name
is
Meg
McRoberts
and
I'm.
The
developer
content
lead
for
the
captain
project
in
this
video
I
will
bring
you
up
to
date
on
what
is
happening.
What
we
call
the
documentation,
revamp
and
talk
about
ways
you
can
contribute
if
you
would
like.
A
A
A
Rajiv
Singh
implemented
much
of
implemented
much
of
docosaurus
as
a
Google
summer
of
code
2022
project
we
are
evaluating
whether
docosaurus
multi-repose
support
is
strong
enough
for
our
needs
and
will
make
a
decision
soon
about
what
tool
set
to
use
tutorials
going
forward.
We
want
to
use
killer
Coda
to
provide
interactive
tutorials
that
do
not
require
the
user
to
install
captain
in
order
to
explore
some
of
its
capabilities.
A
The
new
Explorer
kept
in
document
uses
this
approach
to
replace
the
old
Quick
Start
thanks
to
absal
Ansari
for
driving
this
move
to
killer
Coda
and
doing
the
first
implementation.
It
was
a
fabulous
addition
here.
We
need
people
to
develop
and
maintain
additional
interactive
tutorials.
We
especially
need
tutorials
for
more
advanced
topics.
A
A
We've
create
we've
started
to
create
reference
Pages
for
configurations
and
miscellaneous
to
supplement
the
reference
Pages
for
CLI
commands
and
API
functions
that
have
always
been
there.
We're
adding
differences
between
version
sections
to
each
page
as
appropriate
and
including
links
to
the
software
source.
A
It
has
sub
pages
for
all
sorts
of
installation
topics,
some
of
which
are
optional,
some
of
which
are
not
hidden
under
because
of
our
current
CSS
I
hope
this
will
be
fixed
in
the
new
tools
underneath,
if
you
scroll
past
all
of
the
cards
for
the
individual
sections,
we
have
a
sequential
reference
list
of
the
stages
to
the
steps
that
you
need
to
take
to
install
Captain
for
anything
again.
Some
of
these
are
optional.
Some
are
required,
some
are
for
production
systems,
only
some
are
for
exploratory
demonstration
studies
sessions.
A
Only
we
were
finding
that
a
lot
of
people
were
using
the
old
tutorials
as
a
guide
for
how
to
actually
set
up
their
system
and
that
made
for
some
problems.
So
we
are
attempting
to
fix
that
here.
We
need
to
add
a
lot
more
content,
especially
related
to
installing
a
production
instance
of
Captain.
We
need
to
make
it
very
clear
about
differences
in
installation
for
study
and
demonstration
versus
production
assistance
of
Captain,
and
we
also
need
to
add
some
information
about
how
to
install
a
development
environment.
A
The
manage
kept
in
projects
section
has
discusses
what
I
consider
the
mechanics
of
working
with
projects
has
all
the
pulls
all
the
information
together.
These
are
General
tasks
that
you're
going
to
have
to
do
no
matter
what
sort
of
a
captain
project
you're
running.
So
you
have
to
create
a
project.
You
have
to
create
a
service,
delete,
a
project,
modify
a
project,
manage
tasks
and
sequences.
These
each
have
sequence
sections
in
here.
A
The
Define
Captain
section
is
new.
It
is.
This
is
supposed
to
have
a
number
of
pages
on
different
topics
that
describe
how
to
do
a
specific
task
or
what
we
call
a
use
case
for
a
project
right
now.
It
pretty
much
pulls
together.
The
information
we
had
from
the
old
set.
This
section
needs
a
lot
of
work.
It
needs
a
lot
of
new
materials.
A
It
doesn't
have
materials
to
reflect
a
lot
of
the
newer
functionality,
that's
available
with
Captain
and
more
and
more
things
that
we're
learning
about
how
to
do
it.
So
we'll
do
some
work,
but
in
the
meanwhile,
because
it's
always
going
to
be
miscellaneous.
We're
going
to
have
a
little
pathway
here,
a
quick
description
of
what's
here,
different
things
one
can
do,
and
each
of
them
of
course
link
into
one
of
the
Pages
where
you
have
details
and
examples
reference
pages.
Of
course,
we've
always
had
reference
pages
for
the
CLI
commands
and
the
API
functions.
A
We've
started
to
create
function,
page
reference
Pages
for
configurations
or
files
and
for
miscellaneous
information,
we're
adding
differences
between
versions,
sections
to
these
Pages
as
appropriate.
We
need
more
pages,
more
content
and
better
structure,
we're
still
figuring
out
what
structure
we'll
use
we'll
very
quickly.
Look
at
this,
you
can
look
at
the
more
in
configurations
for
incidents.
A
I
should
set
that
up
differently.
Oh
you
see,
we've
got
page
for
Shipyard.
We've
got
a
page
for
the
remediation
configuration
file,
SLI
SLO
the
values.yaml
file,
the
the
main
file
that
describes
the
Helm
service
that
you
can
use
to
install
again
this
section.
It's
a
good
start,
it's
a
place.
For
instance,
if
you
look
in
the
shipyard,
you'll
find
all
sorts
of
details
about
the
specific
things
that
you
can
do
and
can't
do
various
details
in
here
fairly
comprehensive
information
and
we'll
keep
working
to
make
it
more
and
more
comprehensive.
A
A
A
A
They
are
every
other
week
we
have
a
community
meeting
and
in
the
intervening
weeks
we
have
development
meetings.
There's
a
link
here
to
a
page
that
has
schedules
and
calendars
a
link
to
RSVP
minutes
and
links
for
previous
meetings,
and
you
can
add
an
item
if
you
want
to
discuss
something,
just
go
ahead
and
add
it
to
the
agenda
of
an
upcoming
meeting
and
you
will
be
called
upon
so
ways.
You
can
help
lots
and
lots
of
ways,
of
course,
contribute
content.
If
you
know
something,
that's
not
in
the
docs.
A
A
First
issues
available
for
people
who
are
just
looking
to
something
to
add,
but
you
don't
there's
lesser
ways:
if
you're,
not
a
writer,
whatever
review
and
test
the
docs,
just
pull
out
an
old
Dock
and
go
through
and
try
to
follow
the
procedure
and
see
if
it
works.
If
you
find
errors
or
omissions,
you
can
submit
a
PR
to
correct
it
or
you
can
file
an
issue
identifying
material,
I'll,
review,
open,
PRS
and
I'm
sure
we're
going
to
need
some
help.