Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Portland 2020 videos #1330

Merged
merged 3 commits into from
Sep 2, 2020
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
48 changes: 32 additions & 16 deletions docs/_data/portland-2020-sessions.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
- title: The Search for Search
slug: the-search-for-search-paul-logan
series: Write the Docs Portland
series_slug: the-search-for-search-paul-logan
series_slug: portland
youtubeId: yMN_XWHEAy4
year: 2020
speakers:
- name: Paul Logan
Expand All @@ -27,7 +28,8 @@
practices'
slug: collaborating-with-teams-on-content-strategy-planning-pitfalls-and-best-practices-kateryna-osadchenko
series: Write the Docs Portland
series_slug: collaborating-with-teams-on-content-strategy-planning-pitfalls-and-best-practices-kateryna-osadchenko
series_slug: portland
youtubeId: AE4LleFg1iI
year: 2020
speakers:
- name: Kateryna Osadchenko
Expand All @@ -50,7 +52,8 @@
- title: 'Moving beyond empathy: a11y in documentation'
slug: moving-beyond-empathy-a11y-in-documentation-alexandra-white
series: Write the Docs Portland
series_slug: moving-beyond-empathy-a11y-in-documentation-alexandra-white
series_slug: portland
youtubeId: PS8ywGg0x-U
year: 2020
speakers:
- name: Alexandra White
Expand Down Expand Up @@ -86,7 +89,8 @@
- title: 'Writing Backwards: Documenting the End-of-Life of a Product'
slug: writing-backwards-documenting-the-end-of-life-of-a-product-anni-bond
series: Write the Docs Portland
series_slug: writing-backwards-documenting-the-end-of-life-of-a-product-anni-bond
series_slug: portland
youtubeId: vvpELALAUUc
year: 2020
speakers:
- name: Anni Bond
Expand All @@ -107,7 +111,8 @@
- title: Creating Quality Sample Code
slug: creating-quality-sample-code-jessica-garson
series: Write the Docs Portland
series_slug: creating-quality-sample-code-jessica-garson
series_slug: portland
youtubeId: yhrbkReYbf0
year: 2020
speakers:
- name: Jessica Garson
Expand All @@ -122,7 +127,8 @@
- title: 'Read the Rules: What technical writers can learn from board game design'
slug: read-the-rules-what-technical-writers-can-learn-from-board-game-design-matthew-baldwin
series: Write the Docs Portland
series_slug: read-the-rules-what-technical-writers-can-learn-from-board-game-design-matthew-baldwin
series_slug: portland
youtubeId: 7a3xEl8C3Lc
year: 2020
speakers:
- name: Matthew Baldwin
Expand All @@ -147,7 +153,8 @@
- title: 'Finding the line: Balancing business continuity and documentation debt'
slug: finding-the-line-balancing-business-continuity-and-documentation-debt-luca-janssens
series: Write the Docs Portland
series_slug: finding-the-line-balancing-business-continuity-and-documentation-debt-luca-janssens
series_slug: portland
youtubeId: n7BNAP-zsR0
year: 2020
speakers:
- name: Luca Janssens
Expand Down Expand Up @@ -209,7 +216,8 @@
to the user'
slug: documentation-as-an-application-enabling-interactive-content-that-is-tailored-to-the-user-ryan-paul
series: Write the Docs Portland
series_slug: documentation-as-an-application-enabling-interactive-content-that-is-tailored-to-the-user-ryan-paul
series_slug: portland
youtubeId: aLVvSyenA6s
year: 2020
speakers:
- name: Ryan Paul
Expand Down Expand Up @@ -259,7 +267,8 @@
data'
slug: model-view-docs-taming-large-scale-documentation-projects-using-structured-data-luc-perkins
series: Write the Docs Portland
series_slug: model-view-docs-taming-large-scale-documentation-projects-using-structured-data-luc-perkins
series_slug: portland
youtubeId: l9cdOSfWUDg
year: 2020
speakers:
- name: Luc Perkins
Expand All @@ -283,7 +292,8 @@
- title: Globalise the docs
slug: globalise-the-docs-lucy-carey
series: Write the Docs Portland
series_slug: globalise-the-docs-lucy-carey
series_slug: portland
youtubeId: D5BchQwaM8Y
year: 2020
speakers:
- name: Lucy Carey
Expand Down Expand Up @@ -326,7 +336,8 @@
- title: Don’t Fear Migration! How to Successfully Move Docs to a New Tool
slug: don-t-fear-migration-how-to-successfully-move-docs-to-a-new-tool-brooke-wayne
series: Write the Docs Portland
series_slug: don-t-fear-migration-how-to-successfully-move-docs-to-a-new-tool-brooke-wayne
series_slug: portland
youtubeId: 5asLqBaVVmg
year: 2020
speakers:
- name: Brooke Wayne
Expand Down Expand Up @@ -374,7 +385,8 @@
- title: Why SDK Docs Matter — And What I’m Doing About It!
slug: why-sdk-docs-matter-and-what-i-m-doing-about-it-shavindri-dissanayake-shavi
series: Write the Docs Portland
series_slug: why-sdk-docs-matter-and-what-i-m-doing-about-it-shavindri-dissanayake-shavi
series_slug: portland
youtubeId: D0QY7MXV3Ho
year: 2020
speakers:
- name: Shavindri Dissanayake (Shavi)
Expand Down Expand Up @@ -448,7 +460,8 @@
Scientists and Engineers alike
slug: building-a-content-focused-scientific-document-authoring-workflow-for-data-scientists-and-engineers-alike-colin-dean
series: Write the Docs Portland
series_slug: building-a-content-focused-scientific-document-authoring-workflow-for-data-scientists-and-engineers-alike-colin-dean
series_slug: portland
youtubeId: m1Lhy3fheuY
year: 2020
speakers:
- name: Colin Dean
Expand Down Expand Up @@ -480,7 +493,8 @@
to Help Shape Content'
slug: walking-backwards-tracing-the-new-customer-journey-from-finish-to-start-to-help-shape-content-sally-stumbo
series: Write the Docs Portland
series_slug: walking-backwards-tracing-the-new-customer-journey-from-finish-to-start-to-help-shape-content-sally-stumbo
series_slug: portland
youtubeId: UOjbIZr-G_Q
year: 2020
speakers:
- name: Sally Stumbo
Expand Down Expand Up @@ -519,7 +533,8 @@
Testing Intersect '
slug: where-documentation-cloud-hosted-interactive-tutorials-and-continuous-integration-testing-intersect-dan-gunter
series: Write the Docs Portland
series_slug: where-documentation-cloud-hosted-interactive-tutorials-and-continuous-integration-testing-intersect-dan-gunter
series_slug: portland
youtubeId: NIxopuBhnV4
year: 2020
speakers:
- name: Dan Gunter
Expand Down Expand Up @@ -559,7 +574,8 @@
- title: Set your data free with model-based architecture diagramming
slug: set-your-data-free-with-model-based-architecture-diagramming-avi-flax
series: Write the Docs Portland
series_slug: set-your-data-free-with-model-based-architecture-diagramming-avi-flax
series_slug: portland
youtubeId: 3i-C7qbRGGQ
year: 2020
speakers:
- name: Avi Flax
Expand Down
26 changes: 22 additions & 4 deletions docs/_ext/videos.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ def load_conference_data():
Generate a dict with all data of all conferences including
session details.
"""
# Speakers are the legacy format, >=2020 conferences have a sessions file
speakers_file_pattern = re.compile(r'(\d{4}).(\w+).speakers')
sessions_file_pattern = re.compile(r'(\w+)-(\d{4})-day-(\d+)')
sessions_file_pattern = re.compile(r'(\w+)-(\d{4})-sessions')
result = {}
for f in glob.glob('_data/*.yaml'):
base = os.path.basename(f)
Expand All @@ -54,6 +55,20 @@ def load_conference_data():
continue
mo = sessions_file_pattern.match(base)
if mo:
region = mo.group(1)
year = int(mo.group(2))
if year not in result:
result[year] = {}
if region not in result[year]:
result[year][region] = {}
result[year][region]['speakers'] = load_yaml(f)
for session in result[year][region]['speakers']:
normalize_session(session)
session['year'] = year
session['series'] = u'Write the Docs {}'.format(region.upper())
session['series_slug'] = region
session['event'] = u'Write the Docs {} {}'.format(region.upper(), year)
session['path'] = 'conf/{series_slug}/{year}/videos/{slug}'.format(**session)
continue
return result

Expand All @@ -66,18 +81,21 @@ def generate_video_content(session, year, region, session_idx):
data['year'] = year
data['region'] = region
data['session_idx'] = session_idx

data['data_file'] = f'/_data/{year}.{region}.speakers.yaml' if year < 2020 else f'/_data/{region}-{year}-sessions.yaml'
return u'''{title}
{title_marker}

.. datatemplate-video::
:source: /_data/{year}.{region}.speakers.yaml
:source: {data_file}
:template: videos/video-detail.html
:key: {session_idx}

'''.format(**data)


def generate_video_listing(year, series):
data_file = f'/_data/{year}.{series}.speakers.yaml' if year < 2020 else f'/_data/{series}-{year}-sessions.yaml'
return u'''Videos of Write the Docs {series_title} {year}
=============================================================

Expand All @@ -88,9 +106,9 @@ def generate_video_listing(year, series):
*

.. datatemplate::
:source: /_data/{year}.{series}.speakers.yaml
:source: {data_file}
:template: videos/video-listing.html
'''.format(year=year, series=series, series_title=series.upper())
'''.format(year=year, series=series, series_title=series.upper(), data_file=data_file)


def main():
Expand Down
5 changes: 3 additions & 2 deletions docs/_scripts/pretalx2wtd.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
yaml.add_representer(OrderedDict, RoundTripRepresenter.represent_dict, representer=RoundTripRepresenter)


def convert_to_yaml(year, series, yaml_output, pretalx_slug):
def convert_to_yaml(year, series, series_slug, yaml_output, pretalx_slug):
if not os.environ.get('PRETALX_TOKEN'):
print('Error: PRETALX_TOKEN not found in environment variables.')
return
Expand All @@ -49,7 +49,7 @@ def convert_to_yaml(year, series, yaml_output, pretalx_slug):
('title', talk['title']),
('slug', slug),
('series', series),
('series_slug', slug),
('series_slug', series_slug),
('year', int(year)),
('speakers', speaker_info),
('abstract', markdown.markdown(talk['abstract'])),
Expand Down Expand Up @@ -105,6 +105,7 @@ def search_answers(speaker_dict, search_string):
convert_to_yaml(
year='2020',
series='Write the Docs Prague',
series_slug='prague',
yaml_output='../_data/prague-2020-sessions.yaml',
pretalx_slug='wtd-prague-2020'
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Building a content-focused, scientific document authoring workflow for Data Scientists and Engineers alike
==========================================================================================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 12

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Collaborating with teams on content strategy planning: pitfalls and best practices
==================================================================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 1

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Creating Quality Sample Code
============================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 4

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Documentation as an application: enabling interactive content that is tailored to the user
==========================================================================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 7

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Don’t Fear Migration! How to Successfully Move Docs to a New Tool
=================================================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 10

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Finding the line: Balancing business continuity and documentation debt
======================================================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 6

8 changes: 8 additions & 0 deletions docs/videos/portland/2020/globalise-the-docs-lucy-carey.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Globalise the docs
==================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 9

12 changes: 12 additions & 0 deletions docs/videos/portland/2020/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Videos of Write the Docs PORTLAND 2020
=============================================================

.. toctree::
:glob:
:hidden:

*

.. datatemplate::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-listing.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Model-view-docs: taming large-scale documentation projects using structured data
================================================================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 8

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Moving beyond empathy: a11y in documentation
============================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 2

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Read the Rules: What technical writers can learn from board game design
=======================================================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 5

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Set your data free with model-based architecture diagramming
============================================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 15

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
The Search for Search
=====================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 0

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Walking Backwards: Tracing the New Customer Journey from Finish to Start to Help Shape Content
==============================================================================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 13

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Where Documentation, Cloud-hosted Interactive Tutorials and Continuous Integration Testing Intersect
=====================================================================================================

.. datatemplate-video::
:source: /_data/portland-2020-sessions.yaml
:template: videos/video-detail.html
:key: 14

Loading