Add pre-commit config (#2483)

* Add pre-commit config

* Fix pre-commit hooks for YAML schema validation

- Exclude schema files from check-yaml hook (they use multi-document YAML format)
- Exclude schema files from yamllint hook
- Fix yamale hooks to properly handle file arguments using bash wrapper
- Change yamale hooks to use system language instead of python
- Exclude schema files from being validated against themselves

This resolves all pre-commit validation errors.

* Fix linting issues

Author: ericholscher

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+        files: ^docs/_data/.*\.(yml|yaml)$
+        exclude: ^docs/_data/schema-.*\.yaml$
+      - id: end-of-file-fixer
+        files: ^docs/_data/.*\.(yml|yaml)$
+      - id: trailing-whitespace
+        files: ^docs/_data/.*\.(yml|yaml)$
+
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.26.3
+    hooks:
+      - id: yamllint
+        files: ^docs/_data/.*\.(yml|yaml)$
+        exclude: ^docs/_data/schema-.*\.yaml$
+
+  - repo: local
+    hooks:
+      - id: yamale-config
+        name: Validate conference config YAML against schema
+        entry: bash -c 'for f in "$@"; do yamale -s docs/_data/schema-config.yaml "$f" || exit 1; done' --
+        language: system
+        files: ^docs/_data/.*-config\.(yml|yaml)$
+        exclude: ^docs/_data/schema-config\.yaml$
+      - id: yamale-schedule
+        name: Validate schedule YAML against schema
+        entry: bash -c 'for f in "$@"; do yamale -s docs/_data/schema-schedule.yaml "$f" || exit 1; done' --
+        language: system
+        files: ^docs/_data/.*-schedule\.(yml|yaml)$
+        exclude: ^docs/_data/schema-schedule\.yaml$
+      - id: yamale-sessions
+        name: Validate sessions YAML against schema
+        entry: bash -c 'for f in "$@"; do yamale -s docs/_data/schema-sessions.yaml "$f" || exit 1; done' --
+        language: system
+        files: ^docs/_data/.*-sessions\.(yml|yaml)$
+        exclude: ^docs/_data/schema-sessions\.yaml$

docs/_data/2017.na.speakers.yaml

@@ -1151,6 +1151,6 @@
         slug: andrea-longo
         twitter: feorlen
     title: Do you know a runbook from a flip book? How sysadmins use documentation
-    
+
     year: 2017
     youtubeId: QDxoqWpyzo8

docs/_data/atlantic-2023-schedule.yaml

@@ -46,7 +46,7 @@ talks_day1:
   - duration: '0:20'
     title: '🍲 Snack break'
   - duration: '0:30'
-    title: ⚡️ Lightning Talks 
+    title: ⚡️ Lightning Talks
   - duration: '0:05'
     title: '⏲ 5 minute break'
   - duration: '0:30'
@@ -113,4 +113,3 @@ talks_day2:
     title: Hallway track - Chat with other attendees
   - duration: '0:00'
     title: '<b>Conference ends 😔</b>'
-

docs/_data/atlantic-2023-sessions.yaml

@@ -6,8 +6,8 @@
   speakers:
   - name: Ian Cowley
     slug: ian-cowley
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: '<p>Simple glossaries are relatively easy to set up for individual projects,
     but they become difficult to manage when you try to scale them - especially when
     trying to scale the management of terms and definitions across multiple platforms,
@@ -50,12 +50,12 @@
   speakers:
   - name: Josh Peacock
     slug: josh-peacock
-    twitter: 
-    website: 
+    twitter:
+    website:
   - name: Dennis Mortensen
     slug: dennis-mortensen
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: '<p>Your customer’s desire for self-service support options, and the importance
     of delivering superior self-service Support, is well documented. Today’s customers
     are savvy, self-reliant and more than comfortable finding answers to their questions
@@ -104,8 +104,8 @@
   speakers:
   - name: Fabrizio Ferri-Benedetti
     slug: fabrizio-ferri-benedetti
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: '<p>A year and a half ago, I had a crazy idea: I''d write <a href="https://www.splunk.com/en_us/resources/amir-and-the-magical-lens.html">a
     children''s book on OpenTelemetry</a>. My goal was to learn the essentials of
     the technology that I document every day at work while having fun along the way.
@@ -131,12 +131,12 @@
   speakers:
   - name: Adam Trujillo
     slug: adam-trujillo
-    twitter: 
-    website: 
+    twitter:
+    website:
   - name: Jeffrey Boruszak
     slug: jeffrey-boruszak
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: '<p>Until recently, our product’s software engineers were primarily responsible
     for writing, updating, and organizing the product’s documentation. But years of
     rapid growth and product evolution resulted in sprawling docs that are a hodge-podge
@@ -176,8 +176,8 @@
   speakers:
   - name: Kristine Sihto
     slug: kristine-sihto
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: '<p>Documentation is inherent to every organisation, and a lot of that
     documentation is bound for external clients. Unfortunately, there are a lot of
     places, both in the architecture of your documents, as well as in the content
@@ -194,8 +194,8 @@
   speakers:
   - name: Katie Riker
     slug: katie-riker
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: '<p>Documentation and user experience (UX) design teams may not seem like
     they go together on the surface - isn’t one concerned with words and the other
     with pictures?
@@ -232,12 +232,12 @@
   speakers:
   - name: Chris Noonan
     slug: chris-noonan
-    twitter: 
-    website: 
+    twitter:
+    website:
   - name: John Hannagan
     slug: john-hannagan
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: '<p>It''s difficult to determine how easy it is to read the content that
     you create. This is especially true for technical documentation, where complex
     concepts and terms that are specific to your product and industry are described.
@@ -268,8 +268,8 @@
   speakers:
   - name: Matt Dodson
     slug: matt-dodson
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: '<p>In this proposal, I argue for a reader-centered, bottom-up approach
     to doc restructuring. To make my case, I draw parallels from the worlds of urban
     design and architecture, citing examples of how top-down approaches often ignore
@@ -325,8 +325,8 @@
   speakers:
   - name: Stephan Delbos
     slug: stephan-delbos
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: '<p>Throughout my career in content, including digital marketing, content
     strategy and product content in the fast-paced world of tech startups, most strategic
     decisions have been based on the goal of getting as many users to look at my content
@@ -368,12 +368,12 @@
   speakers:
   - name: Alexander Schwartz
     slug: alexander-schwartz
-    twitter: 
-    website: 
+    twitter:
+    website:
   - name: Fabrice Flore-Thebault
     slug: fabrice-flore-thebault
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: "<p>For a project of a reasonable size, there's usually more than one
     source for the website that needs to be published. \nThis talk presents how the
     Eclipse Che project leveraged Antra and Antora extensions to create a fully automated
@@ -394,8 +394,8 @@
   speakers:
   - name: Chris Meyns
     slug: chris-meyns
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: '<p>Generative AI tools, especially those using large language models
     (LLMs) such as Bing, Bard, and ChatGPT, or text-to-image models such as Stable
     Diffusion or DALL·E 2, have been taking the technical writing space by storm over
@@ -437,8 +437,8 @@
   speakers:
   - name: Lorna Mitchell
     slug: lorna-mitchell
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: <p>OpenAPI descriptions are an excellent way of having all information
     about an API in one place, and making that available to many different tools.
     As a standard, it can be difficult to get started with, and the resulting files

docs/_data/australia-2022-sessions.yaml

@@ -39,7 +39,7 @@
   - name: Lana Novikova
     slug: lana
     twitter: '@_Unsolved_'
-    website: 
+    website:
   abstract: <p>Lately, there was a discussion in the tech writing community about
     a scientific basis for technical writing. </p><p>For instance, developers have
     computer science which includes algorithms, theory of computation, information
@@ -62,7 +62,7 @@
   speakers:
   - name: Ishara Ilangasinghe
     slug: ishara-ilangasinghe
-    twitter: 
+    twitter:
     website: https://isharailanga.medium.com/
   abstract: <p>Ever since I joined the Tech Industry I have always and always been
     on the other side of the interviews; interviewee. For the first time in my career,
@@ -82,7 +82,7 @@
   - name: Claire Mahoney
     slug: claire-mahoney
     twitter: '@wordofanerd'
-    website: 
+    website:
   abstract: <p>Some content roles are straightforward and let us hit the ground running.
     Other jobs are like arriving on a planet that has never heard of content or docs.
     This is the story of how - as the first tech writer in the business - I brought
@@ -118,8 +118,8 @@
   speakers:
   - name: Alex Fiedler
     slug: alex-fiedler
-    twitter: 
-    website: 
+    twitter:
+    website:
   abstract: <p>Product-led Growth (PLG) is a go-to-market strategy being adopted by
     a growing number of SaaS companies. PLG is based on generating sales from customers
     using the product and succeeding with as little interaction with sales and field
@@ -136,7 +136,7 @@
   - name: Hari Priya
     slug: hari-priya
     twitter: '@hari_priya21'
-    website: 
+    website:
   abstract: '<p>As a college student, I focused more on learning and writing code.
     I never imagined I would land three internships as a Technical Writer. Everything
     happened naturally when I began my journey with the Fedora organisation as an

docs/_data/australia-2023-sessions.yaml

@@ -300,4 +300,4 @@
 
     <p>By the end of this talk, you''ll have a handy list of metrics which may prove
     beneficial  for your team, and a strengthened intuition for when a metric is simply
-    noise to tune out - and what may be worth tuning into.</p>'
+    noise to tune out - and what may be worth tuning into.</p>'

docs/_data/australia-2024-schedule.yaml

@@ -72,7 +72,7 @@ talks_day2:
   - duration: '0:20'
     title: '☕ Coffee break'
   - duration: '0:00'
-    title: "<b>Unconference Starts</b>"   
+    title: "<b>Unconference Starts</b>"
   - duration: '0:30'
     slug: where-journalism-and-advertising-writing-skills-overlap-with-technical-writing-justine-stewart
   - duration: '0:10'
@@ -84,7 +84,7 @@ talks_day2:
   - duration: '0:10'
     title: '✋ 10 min Q&A'
   - duration: '0:00'
-    title: "<b>Unconference Ends</b>"  
+    title: "<b>Unconference Ends</b>"
   - duration: '1:00'
     title: '🍽️ Lunch Break (60 mins)'
   - duration: '0:00'