From 4621d41fe85e74b80587b3fe68f56949b0b9bc1e Mon Sep 17 00:00:00 2001 From: Mahati Shankar Date: Fri, 5 Apr 2024 16:21:56 +0200 Subject: [PATCH] add container examples link to side navigation --- docs/navigation-configuration.md | 8 ++++---- website/docs/README.md | 8 +++++--- .../docs/static/public/navigation-nodes.json | 20 +++++++++++++++++++ 3 files changed, 29 insertions(+), 7 deletions(-) diff --git a/docs/navigation-configuration.md b/docs/navigation-configuration.md index 46b5545dfc..5159e4fdf9 100644 --- a/docs/navigation-configuration.md +++ b/docs/navigation-configuration.md @@ -155,10 +155,10 @@ To define all subsequent nodes, use the category label: { category: 'Links', externalLink: { - url: 'http://www.luigi-project.io', + url: 'http://www.luigi-project.io/docs/navigation-configuration', sameWindow: false }, - label: 'Click here to visit the Luigi homepage', + label: 'Click here to visit the Luigi navigation doc', }, ... ``` @@ -183,10 +183,10 @@ To define all subsequent nodes, use the category label: { category: 'anyId', externalLink: { - url: 'http://www.luigi-project.io', + url: 'http://www.luigi-project.io/docs/navigation-configuration', sameWindow: false }, - label: 'Click here to visit the Luigi homepage', + label: 'Click here to visit the Luigi navigation doc', }, ... ``` \ No newline at end of file diff --git a/website/docs/README.md b/website/docs/README.md index 874ce04f80..785fee1b68 100644 --- a/website/docs/README.md +++ b/website/docs/README.md @@ -3,15 +3,17 @@ Luigi documentation, deployed via netlify and accessible at https://docs.luigi-p ## Development -1. Install dependencies. +1. Make sure that you are in the `website/docs` folder. + +2. Install dependencies. `npm install` -2. Build Project. +3. Build Project. `npm run build` -3. Run Project: This command will serve Luigi Core on Port 4000 and the Client Microfrontends on Port 4001 on separate servers in parallel. To make sure both servers are running locally run them in separate Terminals +4. Run Project: This command will serve Luigi Core on Port 4000 and the Client Microfrontends on Port 4001 on separate servers in parallel. To make sure both servers are running locally run them in separate Terminals `npm run core` and `npm run client` diff --git a/website/docs/static/public/navigation-nodes.json b/website/docs/static/public/navigation-nodes.json index 3b825bdb00..0d766ba565 100644 --- a/website/docs/static/public/navigation-nodes.json +++ b/website/docs/static/public/navigation-nodes.json @@ -138,5 +138,25 @@ "categoryPosition": 8, "position": 7 } + }, + { + "label": "Luigi Container", + "pathSegment": "", + "navigationContext": "doc", + "keepSelectedForChildren": true, + "viewUrl": "__BASE_URL__/docs/", + "context": { + "doc": "" + }, + "category": { + "label": "Examples" + }, + "externalLink": { + "url": "https://github.com/SAP/luigi/tree/main/container/examples" + }, + "metaData": { + "categoryPosition": 8, + "position": 8 + } } ]