asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: create docs workspace (#5174)

Browse Source 
* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
This commit is contained in:
Shahed Nasser
2023-09-21 20:57:15 +03:00
committed by GitHub
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/docs-new-announcement.yml vendored
View File

@@ -43,6 +43,6 @@ jobs:
base: "develop"
title: "chore(docs): Generated Docs Announcement Bar (automated)"
labels: "type: chore"
add-paths: www/docs/**
add-paths: www/apps/docs/**
branch: "chore/generate-announcement"
branch-suffix: "timestamp"

2
.github/workflows/docs-remove-announcement.yml vendored
View File

@@ -41,6 +41,6 @@ jobs:
base: "develop"
title: "chore(docs): Removed Docs Announcement Bar (automated)"
labels: "type: chore"
add-paths: www/docs/**
add-paths: www/apps/docs/**
branch: "chore/remove-announcement"
branch-suffix: "timestamp"

115
.github/workflows/docs-test.yml vendored
View File

@@ -2,8 +2,8 @@ name: Documentation Tests
on:
pull_request:
paths:
- www/docs/**
- www/api-reference/**
- www/**
jobs:
docs-test:
runs-on: ubuntu-latest
@@ -29,17 +29,17 @@ jobs:
with:
extension: docs
- name: Install Docusaurus dependencies
working-directory: www/docs
- name: Install Workspace dependencies
working-directory: www
run: yarn install
- name: Build Docusaurus website
working-directory: www/docs
working-directory: www
env:
NODE_OPTIONS: "--max-old-space-size=8192"
API_URL: "https://docs.medusajs.com"
run: yarn build
run: yarn build:docs
lint:
vale-docs:
runs-on: ubuntu-latest
steps:
- name: Cancel Previous Runs
@@ -53,8 +53,8 @@ jobs:
fetch-depth: 0
- name: Get Directories to Scan
working-directory: www/docs/vale
run: ./get-files.sh
working-directory: www/vale
run: ./get-files.sh docs content references
id: directories
- name: Vale Linter
@@ -63,8 +63,71 @@ jobs:
files: ${{ steps.directories.outputs.LIST }}
fail_on_error: true
vale_flags: '--minAlertLevel=error'
reporter: github-pr-check
token: ${{ github.token }}
filter_mode: nofilter
env:
GITHUB_TOKEN: ${{ github.token }}
REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }}
vale-ui:
runs-on: ubuntu-latest
steps:
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.11.0
with:
access_token: ${{ github.token }}
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Get Directories to Scan
working-directory: www/vale
run: ./get-files.sh ui src/content/docs
id: directories
- name: Vale Linter
uses: errata-ai/vale-action@reviewdog
with:
files: ${{ steps.directories.outputs.LIST }}
fail_on_error: true
vale_flags: '--minAlertLevel=error'
reporter: github-pr-check
token: ${{ github.token }}
filter_mode: nofilter
env:
REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }}
vale-api:
runs-on: ubuntu-latest
steps:
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.11.0
with:
access_token: ${{ github.token }}
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Get Directories to Scan
working-directory: www/vale
run: ./get-files.sh api-reference app/_mdx
id: directories
- name: Vale Linter
uses: errata-ai/vale-action@reviewdog
with:
files: ${{ steps.directories.outputs.LIST }}
fail_on_error: true
vale_flags: '--minAlertLevel=error'
reporter: github-pr-check
token: ${{ github.token }}
filter_mode: nofilter
env:
REVIEWDOG_GITHUB_API_TOKEN: ${{ github.token }}
eslint:
runs-on: ubuntu-latest
@@ -80,11 +143,11 @@ jobs:
fetch-depth: 0
- name: Install dependencies
working-directory: www/docs
working-directory: www
run: yarn install
- name: Run Eslint
working-directory: www/docs
working-directory: www
run: yarn lint:content
code-docs-eslint:
@@ -104,33 +167,9 @@ jobs:
run: yarn install
- name: Install dependencies
working-directory: www/docs
working-directory: www
run: yarn install
- name: Run Eslint
working-directory: www/docs
run: yarn lint
code-api-ref-eslint:
runs-on: ubuntu-latest
steps:
- name: Cancel Previous Runs
uses: styfle/cancel-workflow-action@0.11.0
with:
access_token: ${{ github.token }}
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Install Monorepo dependencies
run: yarn install
- name: Install dependencies
working-directory: www/api-reference
run: yarn install
- name: Run Eslint
working-directory: www/api-reference
working-directory: www
run: yarn lint

2
.github/workflows/generate-api-reference.yml vendored
View File

@@ -43,6 +43,6 @@ jobs:
base: "develop"
title: "chore(docs): Updated API Reference"
labels: "type: chore"
add-paths: www/api-reference/specs
add-paths: www/apps/api-reference/specs
branch: "chore/generate-api-ref"
branch-suffix: "timestamp"

2
.github/workflows/generate-entity-reference.yml vendored
View File

@@ -42,6 +42,6 @@ jobs:
base: "develop"
title: "chore(docs): Generated Entities Reference (automated)"
labels: "type: chore"
add-paths: www/docs/content/references/entities/**
add-paths: www/apps/docs/content/references/entities/**
branch: "chore/generate-entities"
branch-suffix: "timestamp"

2
.github/workflows/generate-js-reference.yml vendored
View File

@@ -42,6 +42,6 @@ jobs:
base: "develop"
title: "chore(docs): Generated JS Client Reference"
labels: "type: chore"
add-paths: www/docs/content/references/js-client/**
add-paths: www/apps/docs/content/references/js-client/**
branch: "chore/generate-js-client"
branch-suffix: "timestamp"

2
.github/workflows/generate-reference.yml vendored
View File

@@ -42,6 +42,6 @@ jobs:
base: "develop"
title: "chore(docs): Generated Services Reference (automated)"
labels: "type: chore"
add-paths: www/docs/content/references/services/**
add-paths: www/apps/docs/content/references/services/**
branch: "chore/generate-services"
branch-suffix: "timestamp"