Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 2 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ An even more fragile process that needs documenting and fixing. Note specificall

WIP (Work In Progress) Docs on how to do this:

1. In `_data/<year>.<city>.speakers.yaml`, add a `youtubeId: 12345678901` key value pair to each talk. See also `_scripts/insert-video-ids.py`.
1. In `_data/<city>-<year>-sessions.yaml`, add a `youtubeId: 12345678901` key value pair to each talk. See also `_scripts/insert-video-ids.py`.

2. Make sure the directory `videos/<city>/<year>` is included in the Video Archive `toctree` in `docs/videos/index.rst`.

Expand All @@ -29,25 +29,13 @@ WIP (Work In Progress) Docs on how to do this:
4. Commit the *relevant* changed files:

* `docs/videos/index.rst`
* `_data/<year>.<city>.speakers.yaml`
* `_data/<city>-<year>-sessions.yaml`
* `docs/videos/<city>/<year>/*`

5. If you want to preview locally:

1. Run `BUILD_VIDEOS=True make livehtml` and browse the new video pages at `http://127.0.0.1:8888`.

#### Troubleshooting

If you run into trouble with broken links to video files, have a look at `_ext/fix_video_yaml.py`:

1. Add a line at the end with the relevant places and dates.

2. Change to the `_ext` directory and run it:

`python fix_video_yaml.py`

3. Commit the fixed `_data/<year>.<city>.speakers.yaml` file.

### Prerequisites for generating the docs locally

1. Install `python 3.9.x` using your package manager, if not installed already. You'll probably need `root` privileges to do this.
Expand Down
4 changes: 2 additions & 2 deletions docs/_data/prague-2021-schedule.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ talks_day1:
title: Break (5 mins)
- title: <b>Unconference Starts</b>
- duration: '0:40'
slug: hitchhiker-s-guide-to-documentation-tools-and-processes-lukas-reu-ner
title: 'Talk removed at speakers request'
- duration: '0:10'
title: Break (10 mins)
- duration: '0:40'
Expand Down Expand Up @@ -97,5 +97,5 @@ talks_day2:
- duration: '0:30'
slug: docs-leadership-how-to-become-a-stronger-leader-for-your-team-jenn-leaver
- duration: '0:15'
title: Closing address
title: Closing address
- title: <b>Conference Ends</b> :(
58 changes: 0 additions & 58 deletions docs/_data/prague-2021-sessions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -164,64 +164,6 @@
aren’t getting written, you’re overwhelmed and a new release is coming out. \nWhy
culture matters and what it is? What is culture clash? \n How do we discover cultural
indicators and work with them to promote an effective docs-first culture?</p>\n</li>\n</ol>"
- title: Hitchhiker's Guide to Documentation Tools and Processes
slug: hitchhiker-s-guide-to-documentation-tools-and-processes-lukas-reu-ner
series: Write the Docs Prague
series_slug: prague
year: 2021
youtubeId: p8-ZLqYtD5o
sketchnoteLink: https://www.flickr.com/photos/writethedocs/51631909467/in/album-72157720128594755/
sketchnoteImage: https://live.staticflickr.com/65535/51631909467_85cea25836_b_d.jpg
speakers:
- name: Lukas Reußner
slug: lukas-reu-ner
twitter: '@lukasreussner'
website:
abstract: '<p>No matter if you are on earth or any other planet, it''s very likely
that one day some Vogon will approach you and ask you the ultimate question: Which
tool and process should we use for our documentation? And the worst thing about
it: the Vogon could be yourself.</p>

<p>Fortunately, there''s a simple answer to that question: DON''T PANIC!</p>

<p>The “small” rest of the answer will be part of this talk. It will guide you
through the maze of finding the right documentation tool(s) and the right documentation
process(s).</p>

<p>When it comes to documentation tools, you''ll find a million out there. At
least that''s what I encountered several times when I had to decide which tool
had to be used in a new documentation project. In this talk, we won''t dive into
the nitty-gritty of specific tools. We will focus on overarching categories, such
as:</p>

<ul>

<li>wikis</li>

<li>authoring systems</li>

<li>word processors</li>

<li>markup code toolchains</li>

<li>media editing tools</li>

</ul>

<p>We''ll then map those tool categories with the following types of use:</p>

<ul>

<li>user groups (contributors, consumers, and operators)</li>

<li>content tasks (creating, editing, reviewing, and styling)</li>

<li>output environments (findability, discoverability, and accessibility)</li>

</ul>

<p>And last but not least, we''ll have a look at different documentation processes
and how they fit to our defined tool categories and types of use.</p>'
- title: How to write a book for (and with) an open source community
slug: how-to-write-a-book-for-and-with-an-open-source-community-felicity-brand
series: Write the Docs Prague
Expand Down
30 changes: 0 additions & 30 deletions docs/_scripts/fix_video_yaml.py

This file was deleted.

5 changes: 2 additions & 3 deletions docs/topics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If you think something is wrongly categorized, please let us know.
:local:
:depth: 2
:backlinks: none

Writing words
-------------

Expand All @@ -36,7 +36,7 @@ Naming and terminology
- |:newspaper:| `Common words and how to identify them </blog/newsletter-june-2020/#common-words-and-how-to-identify-them>`__
- |:movie_camera:| `Even Naming This Talk Is Hard </videos/na/2017/even-naming-this-talk-is-hard-ruthie-bendor/>`__
- |:movie_camera:| `Whatchamacallit: Controlled Vocabularies for Technical Writers </videos/eu/2015/whatchamacallit-controlled-vocabularies-for-technical-writers-eboillat/>`__
-
-

Specific writing questions
~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -507,7 +507,6 @@ Doc tools
- |:newspaper:| `Choosing a CCMS or a static site generator </blog/newsletter-june-2023/#choosing-a-ccms-or-a-static-site-generator>`__
- |:movie_camera:| `Two years of Markdoc: what we’ve learned about balancing developer and author experience </videos/prague/2022/two-years-of-markdoc-what-we-ve-learned-about-balancing-developer-and-author-ex-ryan-paul/>`__
- |:newspaper:| `Standards in documentation tooling </blog/newsletter-december-2021/#standards-in-documentation-tooling>`__
- |:movie_camera:| `Hitchhiker’s Guide to Documentation Tools and Processes </videos/prague/2021/hitchhiker-s-guide-to-documentation-tools-and-processes-lukas-reu-ner/>`__
- |:movie_camera:| `Putting the “tech” in technical writer </videos/portland/2021/putting-the-tech-in-technical-writer-swapnil-ogale/>`__
- |:movie_camera:| `Documentation as an application: enabling interactive content that is tailored to the user </videos/portland/2020/documentation-as-an-application-enabling-interactive-content-that-is-tailored-to-the-user-ryan-paul/>`__
- |:movie_camera:| `Model-view-docs: taming large-scale documentation projects using structured data </videos/portland/2020/model-view-docs-taming-large-scale-documentation-projects-using-structured-data-luc-perkins/>`__
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Adventures in setting up a knowledge system for a research group
.. datatemplate-video::
:source: /_data/prague-2021-sessions.yaml
:template: videos/video-detail.html
:key: 8
:key: 7

Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Alchemy in Adversity (How to become better and more resilient tech writers in a
.. datatemplate-video::
:source: /_data/prague-2021-sessions.yaml
:template: videos/video-detail.html
:key: 7
:key: 6

Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ Customer Feedback is the Fuel in our Engine
.. datatemplate-video::
:source: /_data/prague-2021-sessions.yaml
:template: videos/video-detail.html
:key: 10
:key: 9

Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ From travel content to technical content: my journey
.. datatemplate-video::
:source: /_data/prague-2021-sessions.yaml
:template: videos/video-detail.html
:key: 9
:key: 8

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ How I use applied linguistics to be a better technical writer
.. datatemplate-video::
:source: /_data/prague-2021-sessions.yaml
:template: videos/video-detail.html
:key: 12
:key: 11

Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ How to write a book for (and with) an open source community
.. datatemplate-video::
:source: /_data/prague-2021-sessions.yaml
:template: videos/video-detail.html
:key: 6
:key: 5

Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ So you need to give bad news to users…
.. datatemplate-video::
:source: /_data/prague-2021-sessions.yaml
:template: videos/video-detail.html
:key: 11

:key: 10