Skip to content

Commit

Permalink
docs: Update for v5
Browse files Browse the repository at this point in the history
  • Loading branch information
khalwat committed Oct 1, 2024
1 parent 35de50b commit 887df89
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 14 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/build-and-deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ env:
on:
push:
branches:
- v4
- v5
paths:
- 'docs/**'
pull_request:
Expand All @@ -22,11 +22,11 @@ jobs:
strategy:
fail-fast: true
matrix:
node-version: [ 14.x ]
node-version: [ 20.x ]
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- run: npm ci
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/quality-score.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/?branch=v1) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/coverage.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/?branch=v1) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/build.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/build-status/v1) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/code-intelligence.svg?b=v1)](https://scrutinizer-ci.com/code-intelligence)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)

# Transcoder plugin for Craft CMS 4.x

Expand All @@ -10,7 +10,7 @@ Transcode video & audio files to various formats, and provide video thumbnails

## Requirements

This plugin requires Craft CMS 4.0.0 or later.
This plugin requires Craft CMS 5.0.0 or later.

## Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ MAJOR_VERSION?=5
TAG?=20-alpine
CONTAINER?=$(shell basename $(dir $(CURDIR)))-v${MAJOR_VERSION}-docs
DOCS_DEV_PORT?=400${MAJOR_VERSION}
DOCS_DEST?=../../../sites/nystudio107/web/docs/retour
DOCS_DEST?=../../../sites/nystudio107/web/docs/transcoder
IMAGE_INFO=$(shell docker image inspect $(CONTAINER):$(TAG))
IMAGE_NAME=${CONTAINER}:${TAG}
DOCKER_RUN=docker container run --rm -it -v "${CURDIR}":/app
Expand Down
7 changes: 4 additions & 3 deletions docs/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default defineConfig({
],
logo: '/img/plugin-logo.svg',
editLink: {
pattern: 'https://github.com/nystudio107/craft-transcoder/edit/develop/docs/docs/:path',
pattern: 'https://github.com/nystudio107/craft-transcoder/edit/develop-v5/docs/docs/:path',
text: 'Edit this page on GitHub'
},
algolia: {
Expand All @@ -44,8 +44,9 @@ export default defineConfig({
{text: 'Changelog', link: 'https://nystudio107.com/plugins/transcoder/changelog'},
{text: 'Issues', link: 'https://github.com/nystudio107/craft-transcoder/issues'},
{
text: 'v4', items: [
{text: 'v4', link: '/'},
text: 'v5', items: [
{text: 'v5', link: '/'},
{text: 'v4', link: 'https://nystudio107.com/docs/transcoder/v4/'},
{text: 'v3', link: 'https://nystudio107.com/docs/transcoder/v3/'},
],
},
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Transcoder plugin for Craft CMS 4.x
title: Transcoder plugin for Craft CMS
description: Documentation for the Transcoder plugin. The Transcoder plugin allows you to transcode video & audio files to various formats, and provide video thumbnails
---
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/quality-score.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/?branch=v4) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/coverage.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/?branch=v4) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/build.png?b=v4)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/build-status/v4) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/code-intelligence.svg?b=v4)](https://scrutinizer-ci.com/code-intelligence)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-transcoder/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)

# Transcoder plugin for Craft CMS 4.x
# Transcoder plugin for Craft CMS 5.x

Transcode video & audio files to various formats, and provide video thumbnails

Expand All @@ -14,7 +14,7 @@ Transcode video & audio files to various formats, and provide video thumbnails

## Requirements

This plugin requires Craft CMS 4.0.0 or later.
This plugin requires Craft CMS 5.0.0 or later.

## Installation

Expand Down

0 comments on commit 887df89

Please sign in to comment.