From 9e6ade847b824b0af690690729ed8ceb2dd447a5 Mon Sep 17 00:00:00 2001 From: Andrew Welch Date: Mon, 30 Sep 2024 22:12:53 -0400 Subject: [PATCH] docs: Update for v5 --- .github/workflows/build-and-deploy-docs.yml | 10 +++++----- README.md | 2 +- docs/Makefile | 2 +- docs/docs/.vitepress/config.ts | 7 ++++--- docs/docs/index.md | 2 +- 5 files changed, 12 insertions(+), 11 deletions(-) diff --git a/.github/workflows/build-and-deploy-docs.yml b/.github/workflows/build-and-deploy-docs.yml index 7984ba2..41a6921 100644 --- a/.github/workflows/build-and-deploy-docs.yml +++ b/.github/workflows/build-and-deploy-docs.yml @@ -1,6 +1,6 @@ name: Build and Deploy Docs env: - DOCS_DEST_DIR: /transcoder/ + DOCS_DEST_DIR: /transcoder/v4/ on: push: branches: @@ -9,7 +9,7 @@ on: - 'docs/**' pull_request: branches: - - v1 + - v4 paths: - 'docs/**' workflow_dispatch: @@ -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 diff --git a/README.md b/README.md index 1878be7..041c0e3 100644 --- a/README.md +++ b/README.md @@ -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=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) # Transcoder plugin for Craft CMS 4.x diff --git a/docs/Makefile b/docs/Makefile index 426d1ec..0080963 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ MAJOR_VERSION?=4 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 diff --git a/docs/docs/.vitepress/config.ts b/docs/docs/.vitepress/config.ts index 6d74db9..e263051 100644 --- a/docs/docs/.vitepress/config.ts +++ b/docs/docs/.vitepress/config.ts @@ -3,7 +3,7 @@ import {defineConfig} from 'vitepress' export default defineConfig({ title: 'Transcoder Plugin', description: 'Documentation for the Transcoder plugin', - base: '/docs/transcoder/', + base: '/docs/transcoder/v4/', lang: 'en-US', head: [ ['meta', {content: 'https://github.com/nystudio107', property: 'og:see_also',}], @@ -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-v4/docs/docs/:path', text: 'Edit this page on GitHub' }, algolia: { @@ -45,7 +45,8 @@ export default defineConfig({ {text: 'Issues', link: 'https://github.com/nystudio107/craft-transcoder/issues'}, { text: 'v4', items: [ - {text: 'v4', link: '/'}, + {text: 'v5', link: '/'}, + {text: 'v4', link: 'https://nystudio107.com/docs/transcoder/v4/'}, {text: 'v3', link: 'https://nystudio107.com/docs/transcoder/v3/'}, ], }, diff --git a/docs/docs/index.md b/docs/docs/index.md index feff235..c3c5795 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,5 +1,5 @@ --- -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)