build(dev-deps): upgrade VuePress to v1.7.1

uses: `$ yarn upgrade-interactive --latest vuepress`
- [email protected]

Add new workspace `docs` (single package).
Update prebuild cli command script.

Signed-off-by: Antoine Leblanc <[email protected]>

.gitignore

@@ -2,7 +2,7 @@ node_modules
 dist
 dist-*
 .memsourcerc.yaml
-docs/.vuepress/public/assets/json/packages.json
+/docs/docs/.vuepress/public/assets/json/packages.json
 .extras*
 .env
 /packages/manager/tools/testcafe/config/**/*.json

docs/README.md

@@ -1,46 +1,31 @@
----
-home: true
-actionText: Get Started →
-actionLink: /guide/
-footer: BSD 3-Clause Licensed | Copyright © 2020-present OVH SAS
----
-
-<div class="features">
-  <div class="feature">
-    <h2>Application</h2>
-    <p>Manage your services with ease by using our control panel.</p>
-    <a
-      href="https://ovh.com/manager/"
-      rel="noopener noreferrer"
-      target="_blank">
-      ovh.com/manager
-      <icon-external-link/>
-    </a>
-  </div>
-  <div class="feature">
-    <h2>Website</h2>
-    <p>To have more informations about our products, please visit our website</p>
-    <a
-      href="https://ovhcloud.com"
-      rel="noopener noreferrer"
-      target="_blank">
-      ovhcloud.com
-      <icon-external-link/>
-    </a>
-  </div>
-  <div class="feature">
-    <h2>Guides</h2>
-    <p>A good way to find answer to some "how to" questions about OVHcloud products.</p>
-    <a
-      href="https://docs.ovh.com"
-      rel="noopener noreferrer"
-      target="_blank">
-      docs.ovh.com
-      <icon-external-link/>
-    </a>
-  </div>
-</div>
-
-::: warning COMPATIBILITY NOTE
-Manager requires [Node.js](https://nodejs.org) >=12.13 and [Yarn](https://yarnpkg.com/) >=1.21.1.
-:::
+# ovh.github.io/manager
+
+This site is built with [VuePress][]. Site content is written in Markdown format located in `docs`.
+
+## Developing
+
+1. Clone repository
+
+```sh
+$ git clone [email protected]:ovh/manager.git
+```
+
+2. Install dependencies
+
+```sh
+$ yarn
+```
+
+3. Start local development environment
+
+```sh
+$ yarn workspace @ovh-ux/manager-documentation run dev
+```
+
+## Deploying
+
+```sh
+$ yarn workspace @ovh-ux/manager-documentation run deploy
+```
+
+[VuePress]: https://vuepress.vuejs.org/

docs/.vuepress/cli/prebuild.js → docs/docs/.vuepress/cli/prebuild.js

@@ -3,13 +3,13 @@ const path = require('path');
 const pick = require('lodash/pick');
 
 // Get all workspaces defined in the `package.json` file.
-const { workspaces } = require('../../../package.json');
+const { workspaces } = require('./../../../../package.json');
 
 // Keep the bare minimum entries from all package.json files.
 const entries = ['name', 'version', 'description', 'repository'];
 
 // Get all packages contained inside the monorepo.
-const directoryPath = path.resolve();
+const directoryPath = path.resolve('../');
 const packages = getMonorepoPackages(directoryPath).map(
   ({ location, package: pkg }) => ({
     location,
@@ -21,7 +21,7 @@ const packages = getMonorepoPackages(directoryPath).map(
 const groupedWorkspaces = workspaces.map((workspace) => {
   const packagesList = packages.filter((pkg) => {
     // Remove the pattern `/*` from the workspace name.
-    if (pkg.location.includes(workspace.slice(0, -2))) {
+    if (workspace.includes('/*') && pkg.location.includes(workspace.slice(0, -2))) {
       return Object.assign(pkg, {
         location: pkg.location.replace(directoryPath, ''),
       });

docs/docs/README.md

@@ -0,0 +1,46 @@
+---
+home: true
+actionText: Get Started →
+actionLink: /guide/
+footer: BSD 3-Clause Licensed | Copyright © 2020-present OVH SAS
+---
+
+<div class="features">
+  <div class="feature">
+    <h2>Application</h2>
+    <p>Manage your services with ease by using our control panel.</p>
+    <a
+      href="https://ovh.com/manager/"
+      rel="noopener noreferrer"
+      target="_blank">
+      ovh.com/manager
+      <icon-external-link/>
+    </a>
+  </div>
+  <div class="feature">
+    <h2>Website</h2>
+    <p>To have more informations about our products, please visit our website</p>
+    <a
+      href="https://ovhcloud.com"
+      rel="noopener noreferrer"
+      target="_blank">
+      ovhcloud.com
+      <icon-external-link/>
+    </a>
+  </div>
+  <div class="feature">
+    <h2>Guides</h2>
+    <p>A good way to find answer to some "how to" questions about OVHcloud products.</p>
+    <a
+      href="https://docs.ovh.com"
+      rel="noopener noreferrer"
+      target="_blank">
+      docs.ovh.com
+      <icon-external-link/>
+    </a>
+  </div>
+</div>
+
+::: warning COMPATIBILITY NOTE
+Manager requires [Node.js](https://nodejs.org) >=12.13 and [Yarn](https://yarnpkg.com/) >=1.21.1.
+:::

docs/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@ovh-ux/manager-documentation",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Manager documentation deployed with GitHub Pages",
+  "scripts": {
+    "build": "vuepress prebuild docs && vuepress build docs",
+    "deploy": "yarn run build && gh-pages -d docs/.vuepress/dist -m \"docs: update documentation [skip ci]\"",
+    "dev": "vuepress prebuild docs && vuepress dev docs"
+  },
+  "devDependencies": {
+    "get-monorepo-packages": "^1.2.0",
+    "gh-pages": "^2.2.0",
+    "vuepress": "^1.7.1"
+  }
+}

lerna.json

@@ -1,6 +1,7 @@
 {
   "lerna": "3.15.0",
   "packages": [
+    "docs",
     "packages/components/*",
     "packages/manager/apps/*",
     "packages/manager/modules/*",

package.json

@@ -5,6 +5,7 @@
   "description": "OVH Control Panel also known as Manager",
   "license": "BSD-3-Clause",
   "workspaces": [
+    "docs",
     "packages/components/*",
     "packages/manager/apps/*",
     "packages/manager/modules/*",
@@ -14,9 +15,6 @@
     "build": "node --experimental-worker scripts/build.js",
     "clean": "lerna clean -y && yarn run clean:dist && rimraf node_modules",
     "clean:dist": "rimraf \"packages/**/dist?(-EU|-CA|-US)\"",
-    "docs:build": "vuepress prebuild docs && vuepress build docs",
-    "docs:deploy": "yarn run docs:build && gh-pages -d docs/.vuepress/dist -m \"docs: update documentation [skip ci]\"",
-    "docs:dev": "vuepress prebuild docs && vuepress dev docs",
     "format": "run-p format:*",
     "format:css": "yarn run lint:css --fix",
     "format:html": "yarn run lint:html && prettier --parser=html --write \"packages/**/*.html\"",
@@ -62,8 +60,6 @@
     "eslint-plugin-prettier": "^3.1.1",
     "esm": "^3.2.25",
     "execa": "^2.0.5",
-    "get-monorepo-packages": "^1.2.0",
-    "gh-pages": "^2.2.0",
     "git-raw-commits": "^2.0.2",
     "git-url-parse": "^11.1.2",
     "htmlhint": "^0.14.1",
@@ -90,8 +86,7 @@
     "stylelint-scss": "^3.18.0",
     "testcafe": "^1.8.4",
     "testcafe-angular-selectors": "^0.4.1",
-    "testcafe-reporter-html": "^1.4.6",
-    "vuepress": "^1.2.0"
+    "testcafe-reporter-html": "^1.4.6"
   },
   "engines": {
     "node": ">=12.13",