Tweet
Tweet

Slide 1

Slide 1 text

Working with Documentation, The OpenStack Way™ How OpenStack Does Documentation Alex Settle Technical Writer, SUSE @dewsday Stephen Finucane Software Engineer, Red Hat @stephenfin Photo by Susan Yin on Unsplash

Slide 2

Slide 2 text

Past (where we’ve come from) Present (where we’re at) Future (where we’re going) AGENDA

Slide 3

Slide 3 text

Software Engineer at . Working on since ~2015 I go where the people need me no one else wants to go Tech Writer at . Working on since ~2014 My whole career has mostly been a happy accident. WHO DIS?

Slide 4

Slide 4 text

Past (where we’ve come from) Present (where we’re at) Future (where we’re going) PAST

Slide 5

Slide 5 text

Past (where we’ve come from) Present (where we’re at) Future (where we’re going) PAST

Slide 6

Slide 6 text

PAST Install nova-volume on the cloud controller While nova-volume does not directly use the network, you must have networking set up for Compute prior to configuring the volumes. On Ubuntu, install nova-volume and lvm2. $ apt-get install lvm2 nova-volume On RHEL and derivatives, the nova-volume service should already be installed. ...

Slide 7

Slide 7 text

PAST

Slide 8

Slide 8 text

PAST

Slide 9

Slide 9 text

PAST

Slide 10

Slide 10 text

PAST

Slide 11

Slide 11 text

Photo by Landon Hook on Unsplash

Slide 12

Slide 12 text

PAST The documentation team are rapidly losing key contributors and core reviewers…[W]e now need to take a step back and realise that the amount of work we are attempting to maintain is out of reach for the team size that we have. At the moment we have 13 cores, of whom none are full time contributors or reviewers. “ ” ⸺ OpenStack manuals project migration spec

Slide 13

Slide 13 text

PAST

Slide 14

Slide 14 text

Past (where we’ve come from) Present (where we’re at) Future (where we’re going) PRESENT

Slide 15

Slide 15 text

PRESENT

Slide 16

Slide 16 text

PRESENT

Slide 17

Slide 17 text

PRESENT ● openstackdocstheme ● oslo_config.sphinxext ● oslo_config.sphinxconfiggen ● oslo_policy.sphinxext ● oslo_policy.sphinxpolicygen ● reno.sphinxext ● os-api-ref ● zuul-sphinx ● ...

Slide 18

Slide 18 text

PRESENT

Slide 19

Slide 19 text

PRESENT doc/source/ ├─ install/ ├─ contributor/ ├─ configuration/ ├─ cli/ ├─ admin/ ├─ user/ └─ reference/

Slide 20

Slide 20 text

PRESENT

Slide 21

Slide 21 text

PRESENT

Slide 22

Slide 22 text

PRESENT $ tox -e docs

Slide 23

Slide 23 text

PRESENT It’s not all roses though…

Slide 24

Slide 24 text

Past (where we’ve come from) Present (where we’re at) Future (where we’re going) FUTURE

Slide 25

Slide 25 text

Photo by Paolo Nicolello on Unsplash

Slide 26

Slide 26 text

FUTURE

Slide 27

Slide 27 text

FUTURE

Slide 28

Slide 28 text

FUTURE

Slide 29

Slide 29 text

Past (where we’ve come from) Present (where we’re at) Future (where we’re going) WRAP UP

Slide 30

Slide 30 text

Working with Documentation, The OpenStack Way™ How OpenStack Does Documentation Alex Settle Technical Writer, SUSE @dewsday Stephen Finucane Software Engineer, Red Hat @stephenfin Photo by Susan Yin on Unsplash