From 3b59a81523aa3016978b937e59cdcef3a5611610 Mon Sep 17 00:00:00 2001 From: Brion Date: Thu, 23 Mar 2023 18:19:11 +0530 Subject: [PATCH 1/3] chore(docs): move the website to separate folder --- docs/.env | 1 - docs/{ => website}/.editorconfig | 0 docs/website/.env | 2 ++ docs/{ => website}/.eslintignore | 0 docs/{ => website}/.eslintrc.cjs | 0 docs/{ => website}/.gitignore | 0 docs/{ => website}/README.md | 2 +- docs/{ => website}/next.config.js | 0 docs/{ => website}/package.json | 2 +- docs/{ => website}/pages/_app.tsx | 0 docs/{ => website}/pages/index.tsx | 0 docs/{ => website}/prettier.config.cjs | 0 docs/{ => website}/public/about/index.html | 0 .../architecture/oxygen-ui-tokens-process.png | Bin .../assets/images/logos/color/figma.svg | 0 .../assets/images/logos/color/react.svg | 0 .../public/assets/images/logos/white/wso2.svg | 0 .../images/oxygen-ui/guidelines-logo.svg | 0 .../oxygen-ui/oxygen-ui-logo-inverted.svg | 0 .../images/oxygen-ui/oxygen-ui-logo.svg | 0 .../images/oxygen-ui/oxygen-ui-mini-logo.svg | 0 .../images/oxygen-ui/primitives-logo.svg | 0 .../assets/images/oxygen-ui/styles-logo.svg | 0 docs/{ => website}/public/favicon.png | Bin docs/{ => website}/public/favicon.svg | 0 docs/{ => website}/stylelint.config.cjs | 0 docs/{ => website}/styles/app.scss | 0 docs/{ => website}/styles/fonts.ts | 0 docs/{ => website}/styles/globals.scss | 0 docs/{ => website}/tsconfig.json | 0 pnpm-lock.yaml | 21 +++++++++--------- pnpm-workspace.yaml | 2 +- 32 files changed, 15 insertions(+), 15 deletions(-) delete mode 100644 docs/.env rename docs/{ => website}/.editorconfig (100%) create mode 100644 docs/website/.env rename docs/{ => website}/.eslintignore (100%) rename docs/{ => website}/.eslintrc.cjs (100%) rename docs/{ => website}/.gitignore (100%) rename docs/{ => website}/README.md (97%) rename docs/{ => website}/next.config.js (100%) rename docs/{ => website}/package.json (95%) rename docs/{ => website}/pages/_app.tsx (100%) rename docs/{ => website}/pages/index.tsx (100%) rename docs/{ => website}/prettier.config.cjs (100%) rename docs/{ => website}/public/about/index.html (100%) rename docs/{ => website}/public/assets/images/architecture/oxygen-ui-tokens-process.png (100%) rename docs/{ => website}/public/assets/images/logos/color/figma.svg (100%) rename docs/{ => website}/public/assets/images/logos/color/react.svg (100%) rename docs/{ => website}/public/assets/images/logos/white/wso2.svg (100%) rename docs/{ => website}/public/assets/images/oxygen-ui/guidelines-logo.svg (100%) rename docs/{ => website}/public/assets/images/oxygen-ui/oxygen-ui-logo-inverted.svg (100%) rename docs/{ => website}/public/assets/images/oxygen-ui/oxygen-ui-logo.svg (100%) rename docs/{ => website}/public/assets/images/oxygen-ui/oxygen-ui-mini-logo.svg (100%) rename docs/{ => website}/public/assets/images/oxygen-ui/primitives-logo.svg (100%) rename docs/{ => website}/public/assets/images/oxygen-ui/styles-logo.svg (100%) rename docs/{ => website}/public/favicon.png (100%) rename docs/{ => website}/public/favicon.svg (100%) rename docs/{ => website}/stylelint.config.cjs (100%) rename docs/{ => website}/styles/app.scss (100%) rename docs/{ => website}/styles/fonts.ts (100%) rename docs/{ => website}/styles/globals.scss (100%) rename docs/{ => website}/tsconfig.json (100%) diff --git a/docs/.env b/docs/.env deleted file mode 100644 index 2fc80e3a..00000000 --- a/docs/.env +++ /dev/null @@ -1 +0,0 @@ -PORT=3000 diff --git a/docs/.editorconfig b/docs/website/.editorconfig similarity index 100% rename from docs/.editorconfig rename to docs/website/.editorconfig diff --git a/docs/website/.env b/docs/website/.env new file mode 100644 index 00000000..bac46503 --- /dev/null +++ b/docs/website/.env @@ -0,0 +1,2 @@ +PORT=3000 +STATIC=true diff --git a/docs/.eslintignore b/docs/website/.eslintignore similarity index 100% rename from docs/.eslintignore rename to docs/website/.eslintignore diff --git a/docs/.eslintrc.cjs b/docs/website/.eslintrc.cjs similarity index 100% rename from docs/.eslintrc.cjs rename to docs/website/.eslintrc.cjs diff --git a/docs/.gitignore b/docs/website/.gitignore similarity index 100% rename from docs/.gitignore rename to docs/website/.gitignore diff --git a/docs/README.md b/docs/website/README.md similarity index 97% rename from docs/README.md rename to docs/website/README.md index c4cb432c..db154eb6 100644 --- a/docs/README.md +++ b/docs/website/README.md @@ -9,7 +9,7 @@ To get started, simply clone this repository and install the necessary dependenc ```bash git clone https://github.com/wso2/oxygen-ui.git -cd oxygen-ui/docs +cd oxygen-ui/docs/website npm install ``` diff --git a/docs/next.config.js b/docs/website/next.config.js similarity index 100% rename from docs/next.config.js rename to docs/website/next.config.js diff --git a/docs/package.json b/docs/website/package.json similarity index 95% rename from docs/package.json rename to docs/website/package.json index 4e101b29..acf147f6 100644 --- a/docs/package.json +++ b/docs/website/package.json @@ -5,7 +5,7 @@ "description": "Documentation of WSO2 Oxygen Design System.", "author": "WSO2", "license": "Apache-2.0", - "homepage": "https://github.com/wso2/oxygen-ui/tree/main/docs#readme", + "homepage": "https://github.com/wso2/oxygen-ui/tree/main/docs/website#readme", "bugs": { "url": "https://github.com/wso2/oxygen/issues" }, diff --git a/docs/pages/_app.tsx b/docs/website/pages/_app.tsx similarity index 100% rename from docs/pages/_app.tsx rename to docs/website/pages/_app.tsx diff --git a/docs/pages/index.tsx b/docs/website/pages/index.tsx similarity index 100% rename from docs/pages/index.tsx rename to docs/website/pages/index.tsx diff --git a/docs/prettier.config.cjs b/docs/website/prettier.config.cjs similarity index 100% rename from docs/prettier.config.cjs rename to docs/website/prettier.config.cjs diff --git a/docs/public/about/index.html b/docs/website/public/about/index.html similarity index 100% rename from docs/public/about/index.html rename to docs/website/public/about/index.html diff --git a/docs/public/assets/images/architecture/oxygen-ui-tokens-process.png b/docs/website/public/assets/images/architecture/oxygen-ui-tokens-process.png similarity index 100% rename from docs/public/assets/images/architecture/oxygen-ui-tokens-process.png rename to docs/website/public/assets/images/architecture/oxygen-ui-tokens-process.png diff --git a/docs/public/assets/images/logos/color/figma.svg b/docs/website/public/assets/images/logos/color/figma.svg similarity index 100% rename from docs/public/assets/images/logos/color/figma.svg rename to docs/website/public/assets/images/logos/color/figma.svg diff --git a/docs/public/assets/images/logos/color/react.svg b/docs/website/public/assets/images/logos/color/react.svg similarity index 100% rename from docs/public/assets/images/logos/color/react.svg rename to docs/website/public/assets/images/logos/color/react.svg diff --git a/docs/public/assets/images/logos/white/wso2.svg b/docs/website/public/assets/images/logos/white/wso2.svg similarity index 100% rename from docs/public/assets/images/logos/white/wso2.svg rename to docs/website/public/assets/images/logos/white/wso2.svg diff --git a/docs/public/assets/images/oxygen-ui/guidelines-logo.svg b/docs/website/public/assets/images/oxygen-ui/guidelines-logo.svg similarity index 100% rename from docs/public/assets/images/oxygen-ui/guidelines-logo.svg rename to docs/website/public/assets/images/oxygen-ui/guidelines-logo.svg diff --git a/docs/public/assets/images/oxygen-ui/oxygen-ui-logo-inverted.svg b/docs/website/public/assets/images/oxygen-ui/oxygen-ui-logo-inverted.svg similarity index 100% rename from docs/public/assets/images/oxygen-ui/oxygen-ui-logo-inverted.svg rename to docs/website/public/assets/images/oxygen-ui/oxygen-ui-logo-inverted.svg diff --git a/docs/public/assets/images/oxygen-ui/oxygen-ui-logo.svg b/docs/website/public/assets/images/oxygen-ui/oxygen-ui-logo.svg similarity index 100% rename from docs/public/assets/images/oxygen-ui/oxygen-ui-logo.svg rename to docs/website/public/assets/images/oxygen-ui/oxygen-ui-logo.svg diff --git a/docs/public/assets/images/oxygen-ui/oxygen-ui-mini-logo.svg b/docs/website/public/assets/images/oxygen-ui/oxygen-ui-mini-logo.svg similarity index 100% rename from docs/public/assets/images/oxygen-ui/oxygen-ui-mini-logo.svg rename to docs/website/public/assets/images/oxygen-ui/oxygen-ui-mini-logo.svg diff --git a/docs/public/assets/images/oxygen-ui/primitives-logo.svg b/docs/website/public/assets/images/oxygen-ui/primitives-logo.svg similarity index 100% rename from docs/public/assets/images/oxygen-ui/primitives-logo.svg rename to docs/website/public/assets/images/oxygen-ui/primitives-logo.svg diff --git a/docs/public/assets/images/oxygen-ui/styles-logo.svg b/docs/website/public/assets/images/oxygen-ui/styles-logo.svg similarity index 100% rename from docs/public/assets/images/oxygen-ui/styles-logo.svg rename to docs/website/public/assets/images/oxygen-ui/styles-logo.svg diff --git a/docs/public/favicon.png b/docs/website/public/favicon.png similarity index 100% rename from docs/public/favicon.png rename to docs/website/public/favicon.png diff --git a/docs/public/favicon.svg b/docs/website/public/favicon.svg similarity index 100% rename from docs/public/favicon.svg rename to docs/website/public/favicon.svg diff --git a/docs/stylelint.config.cjs b/docs/website/stylelint.config.cjs similarity index 100% rename from docs/stylelint.config.cjs rename to docs/website/stylelint.config.cjs diff --git a/docs/styles/app.scss b/docs/website/styles/app.scss similarity index 100% rename from docs/styles/app.scss rename to docs/website/styles/app.scss diff --git a/docs/styles/fonts.ts b/docs/website/styles/fonts.ts similarity index 100% rename from docs/styles/fonts.ts rename to docs/website/styles/fonts.ts diff --git a/docs/styles/globals.scss b/docs/website/styles/globals.scss similarity index 100% rename from docs/styles/globals.scss rename to docs/website/styles/globals.scss diff --git a/docs/tsconfig.json b/docs/website/tsconfig.json similarity index 100% rename from docs/tsconfig.json rename to docs/website/tsconfig.json diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index afd6d320..37844736 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -16,7 +16,7 @@ importers: release-it: 15.9.1 rimraf: 3.0.2 - docs: + docs/website: specifiers: '@next/font': ^13.0.6 '@types/node': 18.11.10 @@ -2345,7 +2345,7 @@ packages: debug: 4.3.4 espree: 9.4.1 globals: 13.19.0 - ignore: 5.2.1 + ignore: 5.2.4 import-fresh: 3.3.0 js-yaml: 4.1.0 minimatch: 3.1.2 @@ -6372,7 +6372,7 @@ packages: /@types/react-dom/18.0.9: resolution: {integrity: sha512-qnVvHxASt/H7i+XG1U1xMiY5t+IHcPGUK7TDMDzom08xa7e86eCeKOiLZezwCKVxJn6NEiiy2ekgX8aQssjIKg==} dependencies: - '@types/react': 18.0.25 + '@types/react': 18.0.26 /@types/react-is/17.0.3: resolution: {integrity: sha512-aBTIWg1emtu95bLTLx0cpkxwGW3ueZv71nE2YFBpL8k/z5czEW8yYpOo8Dp+UUAFAtKwNaOsh/ioSeQnWlZcfw==} @@ -10672,8 +10672,8 @@ packages: eslint: ^7.32.0 || ^8.2.0 eslint-plugin-import: ^2.25.3 dependencies: - '@typescript-eslint/eslint-plugin': 5.46.1_wqh5rj4gay6mpzzdobd4tmdy4i - '@typescript-eslint/parser': 5.46.1_grqhnqpocakf5dew66i47isfme + '@typescript-eslint/eslint-plugin': 5.46.1_est534hxm5svmojdh7vhpcxb64 + '@typescript-eslint/parser': 5.46.1_5ldjemcacbssrrv7slgrertrym eslint: 8.25.0 eslint-config-airbnb-base: 15.0.0_fyln4uq2tv75svthy6prqvt6lm eslint-plugin-import: 2.26.0_jn5v4vtldezgezlg7abxxe34qm @@ -10798,7 +10798,7 @@ packages: eslint-import-resolver-webpack: optional: true dependencies: - '@typescript-eslint/parser': 5.46.1_grqhnqpocakf5dew66i47isfme + '@typescript-eslint/parser': 5.46.1_5ldjemcacbssrrv7slgrertrym debug: 3.2.7 eslint: 8.25.0 eslint-import-resolver-node: 0.3.6 @@ -10859,7 +10859,7 @@ packages: '@typescript-eslint/parser': optional: true dependencies: - '@typescript-eslint/parser': 5.46.1_grqhnqpocakf5dew66i47isfme + '@typescript-eslint/parser': 5.46.1_5ldjemcacbssrrv7slgrertrym array-includes: 3.1.6 array.prototype.flat: 1.3.1 debug: 2.6.9 @@ -10918,7 +10918,7 @@ packages: '@typescript-eslint/eslint-plugin': 5.46.1_wqh5rj4gay6mpzzdobd4tmdy4i '@typescript-eslint/utils': 5.46.1_grqhnqpocakf5dew66i47isfme eslint: 8.25.0 - jest: 29.0.3_@types+node@18.11.18 + jest: 29.0.3_@types+node@16.18.9 transitivePeerDependencies: - supports-color - typescript @@ -11227,7 +11227,7 @@ packages: globals: 13.19.0 globby: 11.1.0 grapheme-splitter: 1.0.4 - ignore: 5.2.1 + ignore: 5.2.4 import-fresh: 3.3.0 imurmurhash: 0.1.4 is-glob: 4.0.3 @@ -13010,7 +13010,6 @@ packages: /ignore/5.2.4: resolution: {integrity: sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==} engines: {node: '>= 4'} - dev: true /immer/9.0.16: resolution: {integrity: sha512-qenGE7CstVm1NrHQbMh8YaSzTZTFNP3zPqr3YU0S0UY441j4bJTg4A2Hh5KAhwgaiU6ZZ1Ar6y/2f4TblnMReQ==} @@ -22037,7 +22036,7 @@ packages: babel-jest: 29.3.1_@babel+core@7.20.5 bs-logger: 0.2.6 fast-json-stable-stringify: 2.1.0 - jest: 29.0.3_@types+node@18.11.18 + jest: 29.0.3_zfha7dvnw4nti6zkbsmhmn6xo4 jest-util: 29.3.1 json5: 2.2.2 lodash.memoize: 4.1.2 diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index abfcdaae..3df63a01 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -1,4 +1,4 @@ packages: - - "docs" + - "docs/*" - "packages/*" - "examples/*" From fe54b335ff905f6f097c8ab571d72862d9885340 Mon Sep 17 00:00:00 2001 From: Brion Date: Thu, 23 Mar 2023 18:19:27 +0530 Subject: [PATCH 2/3] chore(docs): move architecture diagram out --- CONTRIBUTING.md | 2 +- .../architecture/oxygen-ui-tokens-process.png | Bin 2 files changed, 1 insertion(+), 1 deletion(-) rename docs/{website/public/assets => resources}/images/architecture/oxygen-ui-tokens-process.png (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ecef94f5..a8771c0d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -284,7 +284,7 @@ By following these steps, designers can ensure that their design changes are pro Following diagram illustrates the design tokens workflow. - + ## Versioning diff --git a/docs/website/public/assets/images/architecture/oxygen-ui-tokens-process.png b/docs/resources/images/architecture/oxygen-ui-tokens-process.png similarity index 100% rename from docs/website/public/assets/images/architecture/oxygen-ui-tokens-process.png rename to docs/resources/images/architecture/oxygen-ui-tokens-process.png From cc317ee382e16d3622103b7fc31ac122fdc571fb Mon Sep 17 00:00:00 2001 From: Brion Date: Thu, 23 Mar 2023 18:20:45 +0530 Subject: [PATCH 3/3] chore(docs): revert .env change --- docs/website/.env | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/website/.env b/docs/website/.env index bac46503..2fc80e3a 100644 --- a/docs/website/.env +++ b/docs/website/.env @@ -1,2 +1 @@ PORT=3000 -STATIC=true