Deploy preview for PR 111 🛫

SRGSSR · Oct 31, 2024 · d38e013 · d38e013
1 parent adc115f
commit d38e013
Show file tree

Hide file tree

Showing 13 changed files with 921 additions and 0 deletions.
diff --git a/pr-preview/pr-111/.nojekyll b/pr-preview/pr-111/.nojekyll
diff --git a/pr-preview/pr-111/README.md b/pr-preview/pr-111/README.md
@@ -0,0 +1,30 @@
+# Overview
+
+Pillarbox is a versatile media playback ecosystem engineered for Android, Apple, and Web platforms.
+
+Pillarbox is built to be adaptable and generic, ensuring it can be deployed across a variety of media applications. A
+key principle of Pillarbox is that it imposes **no user interface** constraints, empowering each product team to craft
+their own unique playback experience.
+
+It integrates seamlessly with platform features and offers robust customization options for metadata handling,
+asset management, and analytics.
+
+This page covers documentation regarding our core methodologies, cross-platform specifications, development workflows,
+and best practices.
+
+## Platform Repositories and Resources
+
+| Platform   | Repository Link                                                  | Demo Link                                                                           | Documentation Link                                                                                     |
+|------------|------------------------------------------------------------------|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|
+| 🤖 Android | [pillarbox-android](https://github.com/SRGSSR/pillarbox-android) | [Demo Android](https://github.com/SRGSSR/pillarbox-android?tab=readme-ov-file#demo) | [Docs Android](https://android.pillarbox.ch/api)                                                       |
+| 🍎 Apple   | [pillarbox-apple](https://github.com/SRGSSR/pillarbox-apple)     | [Demo Apple](https://testflight.apple.com/join/TS6ngLqf)                            | [Docs Apple](https://swiftpackageindex.com/SRGSSR/pillarbox-apple/3.0.0/documentation/pillarboxplayer) |
+| 🌐 Web     | [pillarbox-web](https://github.com/SRGSSR/pillarbox-web)         | [Demo Web](https://demo.pillarbox.ch)                                               | [Docs Web](https://web.pillarbox.ch/api/)                                                              |
+
+## Web Tools for Pillarbox
+
+`pillarbox-web` provides a set of web tools for additional functionalities to enhance the developer's experience.
+
+| Repository Link                                                                    | Demo Link                            | Description                                      |
+|------------------------------------------------------------------------------------|--------------------------------------|--------------------------------------------------|
+| [pillarbox-web-suite](https://github.com/SRGSSR/pillarbox-web-suite)               | [Demo](https://plugins.pillarbox.ch) | A collection of plugins, themes, and components. |
+| [pillarbox-web-theme-editor](https://github.com/SRGSSR/pillarbox-web-theme-editor) | [Demo](https://editor.pillarbox.ch)  | A tool for editing themes for the player.        |
diff --git a/pr-preview/pr-111/_coverpage.md b/pr-preview/pr-111/_coverpage.md
@@ -0,0 +1,14 @@
+<!-- _coverpage.md -->
+
+<h1 style="display: flex; align-items: center; justify-content: center">
+  <img src="img/srgssr-logo.png" alt="logo" style="height: 80px; margin-right: 10px;">
+  <span>Pillarbox</span>
+</h1>
+
+> **The media player that adapts to you.**
+
+- No UI constraints, fully customizable.
+- Seamless platform integration.
+- Robust asset management and analytics.
+
+[Get Started](#overview)
diff --git a/pr-preview/pr-111/_sidebar.md b/pr-preview/pr-111/_sidebar.md
@@ -0,0 +1,15 @@
+<!-- docs/_sidebar.md -->
+<img src="img/pillarbox-logo.webp" height="25"/> Pillarbox
+
+* [Overview](/)
+
+**Specifications**
+
+* [Monitoring](/specifications/monitoring/MONITORING.md)
+
+**Methodology**
+
+* [Definition of Done](/methodology/DEFINITION_OF_DONE.md)
+* [GitHub Projects Setup](/methodology/GITHUB_PROJECTS_SETUP.md)
+
+---
diff --git a/pr-preview/pr-111/img/pillarbox-logo.webp b/pr-preview/pr-111/img/pillarbox-logo.webp
diff --git a/pr-preview/pr-111/img/srgssr-logo.png b/pr-preview/pr-111/img/srgssr-logo.png
diff --git a/pr-preview/pr-111/index.html b/pr-preview/pr-111/index.html
@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Pillarbox Documentation</title>
+    <link rel="shortcut icon" type="image/x-icon"
+          href="//www.srgssr.ch/typo3conf/ext/is_design/Resources/Public/imgs/favicon.ico">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
+    <meta name="description" content="Description">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+
+    <link rel="stylesheet" media="(prefers-color-scheme: dark)"
+          href="//cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
+    <link rel="stylesheet" media="(prefers-color-scheme: light)"
+          href="//cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
+
+    <style>
+        .sidebar-nav > p {
+            display: flex;
+            align-items: center;
+            gap: 0.2em;
+        }
+
+        :root {
+            --mono-hue: 210;
+            --mono-saturation: 5%;
+            --theme-hue: 213;
+            --theme-saturation: 21%;
+            --theme-lightness: 58%;
+            --base-font-size: 14px;
+        }
+    </style>
+</head>
+<body>
+<div id="app"></div>
+<script>
+    window.$docsify = {
+        repo: 'https://github.com/SRGSSR/pillarbox-documentation',
+        auto2top: true,
+        relativePath: true,
+        coverpage: true,
+        loadSidebar: true,
+        subMaxLevel: 2
+    }
+</script>
+<!-- Docsify v4 -->
+<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
+
+<script src="//unpkg.com/docsify-plugin-flexible-alerts"></script>
+<script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/[email protected]/components/prism-json.min.js"></script>
+<script type="module">
+    import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
+
+    mermaid.initialize({startOnLoad: true});
+    window.mermaid = mermaid;
+</script>
+<script src="//unpkg.com/[email protected]/dist/docsify-mermaid.js"></script>
+</body>
+</html>
diff --git a/pr-preview/pr-111/methodology/DEFINITION_OF_DONE.md b/pr-preview/pr-111/methodology/DEFINITION_OF_DONE.md
@@ -0,0 +1,18 @@
+# Definition of Done (DoD)
+
+This document is a collaborative effort among team members to establish clear criteria for completing tasks. The DoD serves as a guide to ensure the quality and completeness of work within the team.
+
+To meet our standards, every task should adhere to the following criteria:
+
+- Code has been reviewed by at least one other team member.
+- Functionality works as expected and acceptance criteria are met.
+- Coding standards are followed.
+- No critical issues are present.
+- Performance is not compromised.
+- Unit tests pass successfully and the code successfully builds.
+- Code meets accessibility standards.
+- Code is well-documented.
+- README is updated with relevant information.
+- API documentation is updated.
+- Sensitive information is handled securely.
+- Deployment process is documented.
diff --git a/pr-preview/pr-111/methodology/GITHUB_PROJECTS_SETUP.md b/pr-preview/pr-111/methodology/GITHUB_PROJECTS_SETUP.md
@@ -0,0 +1,88 @@
+# GitHub Projects Setup
+
+This article describes how we manage [our product](https://github.com/orgs/SRGSSR/projects/9) with [GitHub Projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).
+
+## Settings
+
+We currently use 3 settings:
+
+- **Status** for the various statuses an issue might have in our workflow. Statuses must be defined in the following order so that board columns are ordered correctly:
+  - **✏️ Draft**: Tasks which have not been sufficiently refined yet.
+  - **📋 Backlog**: Tasks which are ready to be planned.
+  - **🚧  In Progress**: Tasks currently being worked on.
+  - **🍿 Code Review**: Tasks currently being reviewed.
+  - **✅ Done**: Completed tasks.
+- **Sprint**: Duration of 1 week.
+- **Platform**:
+  - **✨ All**
+  - **🤖 Android**
+  - **🍎 Apple**
+  - **🌍 Web**
+
+## Workflows
+
+Workflow management is currently limited on GitHub Projects. Here are the ones we kept and how they are set:
+
+- **Item added to project**: When an issue or pull request is added set its status to _Draft_.
+- **Item reopened**: When an issue or pull request is reopened set its status to _Backlog_.
+- **Item closed**: When an issue or pull request is closed set its status to _Done_.
+- **Pull request merged**: When a pull request is merged set its status to _Done_.
+
+## Views
+
+We have created the following views:
+
+### Sprint board
+
+Displays a board of the the current sprint:
+
+- Layout: Board
+- Fields: Title, Assignees, Status, Platform, Linked pull requests
+- Column field: Status
+- Field sum: Count
+- Sort: Manual
+- Filter: `-status:"✏️ Draft"`
+
+### Drafts
+
+Displays all issues to be refined per platform:
+
+- Layout: Table
+- Fields: Title, Milestone, Platform, Labels
+- Group: Platform
+- Field sum: Count
+- Sort: Manual
+- Filter: `status:"✏️ Draft"`
+
+### Product Backlog
+
+Displays the product backlog for all platforms:
+
+- Layout: Table
+- Fields: Title, Status, Milestone, Platform, Sprint, Labels
+- Group: Status
+- Field sum: Count
+- Sort: Status-desc
+- Filter: `status:"✏️ Draft","📋 Backlog"`
+
+### Current Milestone
+
+Displays the current milestone which represents the current focus:
+
+- Layout: Table
+- Fields: Title, Status, Platform, Sprint, Labels, Milestone
+- Group: Platform
+- Field sum: Count
+- Sort: Manual
+- Filter: `-status:"✅ Done","✏️ Draft" milestone:<name>`
+
+### Sprint List
+
+Displays issues per sprint:
+
+- Layout: Table
+- Fields: Title, Sprint, Milestone, Platform, Status, Linked pull requests, Labels
+- Group: Sprint
+- Field sum: Count
+- Sort: Sprint-desc
+- Filter: `-no:sprint`