From 16db1f657c8accdc9bb1755f8ca9dba447c81a3c Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Mon, 4 Dec 2023 13:48:24 +0100 Subject: [PATCH 01/10] chore: update DEPENDENCIES --- DEPENDENCIES | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEPENDENCIES b/DEPENDENCIES index 57fd61577bc..6cc0648e12f 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -606,7 +606,7 @@ npm/npmjs/-/on-headers/1.0.2, MIT, approved, clearlydefined npm/npmjs/-/once/1.4.0, ISC, approved, clearlydefined npm/npmjs/-/onetime/5.1.2, MIT, approved, clearlydefined npm/npmjs/-/open/8.4.0, MIT, approved, #7102 -npm/npmjs/-/opener/1.5.2, MIT OR WTFPL OR (MIT AND WTFPL), approved, clearlydefined +npm/npmjs/-/opener/1.5.2, MIT AND WTFPL AND WTFPL, approved, #11619 npm/npmjs/-/p-cancelable/1.1.0, MIT, approved, clearlydefined npm/npmjs/-/p-limit/2.3.0, MIT, approved, clearlydefined npm/npmjs/-/p-limit/3.1.0, MIT, approved, clearlydefined From 63cd6fad703a5ab5da648d5020f3dca760c6f32c Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Mon, 4 Dec 2023 13:49:08 +0100 Subject: [PATCH 02/10] chore: remove unecessary demo content --- src/pages/markdown-page.md | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 src/pages/markdown-page.md diff --git a/src/pages/markdown-page.md b/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b6685..00000000000 --- a/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. From fd05840eb290185893992a41173a4de66e152875 Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Tue, 5 Dec 2023 16:19:33 +0100 Subject: [PATCH 03/10] docs: add docs based community section --- docs/community.md | 30 ++++++++++++++++++++++++++++++ docs/community/open-meetings.md | 4 ++++ docs/community/products.mdx | 7 +++++++ docusaurus.config.js | 17 +++++++++-------- sidebars.js | 5 +++++ 5 files changed, 55 insertions(+), 8 deletions(-) create mode 100644 docs/community.md create mode 100644 docs/community/open-meetings.md create mode 100644 docs/community/products.mdx diff --git a/docs/community.md b/docs/community.md new file mode 100644 index 00000000000..5cb6c923872 --- /dev/null +++ b/docs/community.md @@ -0,0 +1,30 @@ +# Tractus-X community + +We warmly welcome You to shape the automotive value chain of the next generation! +The global Tractus-X community consists of a broad range of users, contributors, and committers from various companies ( +and individual actors) in the automotive value chain. We sincerely invite anyone to participate who wants to shape our +architecture, reference implementations KITs for our Catena-X data space. + +## Communication Rules + +A pre-requisite for joining the Tractus-X communication channels is +an [Eclipse Foundation Account](https://accounts.eclipse.org/user/register?destination=user). + +In addition, we encourage you to sign the Eclipse Contribution Agreement (ECA) to contribute to our Tractus-X project. +For example, report and fix bugs or implement enhancements according to the Tractus-X +roadmap. See our [contributing guide](https://eclipse-tractusx.github.io/docs/oss/how-to-contribute) + +For a first contact please use our Tractus-X mailing list to get in touch with our community or a specific product team +you want to contribute. tractusx-dev@eclipse.org + +For quick and informal syncs please use +our [Matrix Chat](https://chat.eclipse.org/#/room/#tools.tractus-x:matrix.eclipse.org) to align on easy topics, ask +questions, share a link or a bite-size piece of information. + +For product alignments please set up a meeting with a tool of your choice as a project manager. The preparation of +meeting minutes is not required. Recurring formal meetings must be communicated via our Tractus-X mailing list. Ad hoc +informal meetings may be organized without prior notice. + +For cross-product alignments the Catena-X Association is currently preparing various committees to support the +coordination of the open-source products and repositories. The goal of a committee is to discuss, define and create a +common vision, roadmap, standards, architecture, KITs, etc. diff --git a/docs/community/open-meetings.md b/docs/community/open-meetings.md new file mode 100644 index 00000000000..7c8b8130f33 --- /dev/null +++ b/docs/community/open-meetings.md @@ -0,0 +1,4 @@ +# Eclipse Tractus-X open meetings + +This page hosts information about all of our open Tractus-X meetings. +These are dedicated sync meetings for specific products, as well as open planning sessions. diff --git a/docs/community/products.mdx b/docs/community/products.mdx new file mode 100644 index 00000000000..a6c27166fa5 --- /dev/null +++ b/docs/community/products.mdx @@ -0,0 +1,7 @@ +--- +title: Tractus-X products +--- + +import ProductOverview from '@site/src/components/ProductOverview'; + + diff --git a/docusaurus.config.js b/docusaurus.config.js index 597a9be923b..d06474362d8 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -45,7 +45,7 @@ const config = { editUrl: 'https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/tree/main/', docLayoutComponent: "@theme/DocPage", - // docItemComponent: "@theme/ApiItem" // Derived from docusaurus-theme-openapi-docs + // docItemComponent: "@theme/ApiItem" // Derived from docusaurus-theme-openapi-docs }, blog: { showReadingTime: true, @@ -73,8 +73,8 @@ const config = { routeBasePath: 'docs-kits', sidebarPath: require.resolve('./sidebarsDocsKits.js'), docLayoutComponent: "@theme/DocPage", - docItemComponent: "@theme/ApiItem" // Derived from docusaurus-theme-openapi-docs - }, + docItemComponent: "@theme/ApiItem" // Derived from docusaurus-theme-openapi-docs + }, ], [ '@docusaurus/plugin-content-docs', @@ -83,7 +83,7 @@ const config = { path: 'docs-products', routeBasePath: 'docs-products', sidebarPath: require.resolve('./sidebarsDocsProducts.js'), - }, + }, ], // ------------DOCUSAURUS PLUGIN REMOTE CONTENT---------------- [ @@ -264,7 +264,7 @@ const config = { sidebarOptions: { groupPathsBy: "tag", }, - }, + }, pcf_exchange_api: { specPath: "./openApi/pcf/catena-x-pcf-endpoint-0_0_3.yaml", // Path to designated spec file outputDir: @@ -385,9 +385,10 @@ const config = { label: 'Tutorials', }, { - to: "/community", - position: "left", - label: "Community", + type: 'doc', + docId: 'community', + position: 'left', + label: 'Community', }, { type: 'dropdown', diff --git a/sidebars.js b/sidebars.js index cf5d2ca75da..9cf40a4ffcc 100644 --- a/sidebars.js +++ b/sidebars.js @@ -102,6 +102,11 @@ const sidebars = { ], }, ], + community: [ + 'community', + 'community/open-meetings', + 'community/products', + ], }; module.exports = sidebars; From 72519b6c798b536301512cfee7be20155d808ec7 Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Tue, 5 Dec 2023 16:30:47 +0100 Subject: [PATCH 04/10] chore: remove old community content --- docs/community.md | 35 +++++++------- src/pages/community.mdx | 50 -------------------- static/img/cx_workflow_idea_to_pr.drawio.svg | 4 -- 3 files changed, 16 insertions(+), 73 deletions(-) delete mode 100644 src/pages/community.mdx delete mode 100644 static/img/cx_workflow_idea_to_pr.drawio.svg diff --git a/docs/community.md b/docs/community.md index 5cb6c923872..ae2203c77a5 100644 --- a/docs/community.md +++ b/docs/community.md @@ -1,8 +1,8 @@ # Tractus-X community We warmly welcome You to shape the automotive value chain of the next generation! -The global Tractus-X community consists of a broad range of users, contributors, and committers from various companies ( -and individual actors) in the automotive value chain. We sincerely invite anyone to participate who wants to shape our +The global Tractus-X community consists of a broad range of users, contributors, and committers from various companies +(and individual actors) in the automotive value chain. We sincerely invite anyone to participate who wants to shape our architecture, reference implementations KITs for our Catena-X data space. ## Communication Rules @@ -11,20 +11,17 @@ A pre-requisite for joining the Tractus-X communication channels is an [Eclipse Foundation Account](https://accounts.eclipse.org/user/register?destination=user). In addition, we encourage you to sign the Eclipse Contribution Agreement (ECA) to contribute to our Tractus-X project. -For example, report and fix bugs or implement enhancements according to the Tractus-X -roadmap. See our [contributing guide](https://eclipse-tractusx.github.io/docs/oss/how-to-contribute) - -For a first contact please use our Tractus-X mailing list to get in touch with our community or a specific product team -you want to contribute. tractusx-dev@eclipse.org - -For quick and informal syncs please use -our [Matrix Chat](https://chat.eclipse.org/#/room/#tools.tractus-x:matrix.eclipse.org) to align on easy topics, ask -questions, share a link or a bite-size piece of information. - -For product alignments please set up a meeting with a tool of your choice as a project manager. The preparation of -meeting minutes is not required. Recurring formal meetings must be communicated via our Tractus-X mailing list. Ad hoc -informal meetings may be organized without prior notice. - -For cross-product alignments the Catena-X Association is currently preparing various committees to support the -coordination of the open-source products and repositories. The goal of a committee is to discuss, define and create a -common vision, roadmap, standards, architecture, KITs, etc. +For example, report and fix bugs or implement enhancements according to the Tractus-X roadmap. See +our [contributing guide](https://eclipse-tractusx.github.io/docs/oss/how-to-contribute) + +- __For a first contact__ please use our Tractus-X mailing list (tractusx-dev@eclipse.org) to get in touch with our + community or a specific product team you want to contribute. +- __For quick and informal syncs__ please use + our [Matrix Chat](https://chat.eclipse.org/#/room/#tools.tractus-x:matrix.eclipse.org) to align on easy topics, ask + questions, share a link or a bite-size piece of information. +- __For product alignments__ please set up a meeting with a tool of your choice as a project manager. The preparation of + meeting minutes is not required. Recurring formal meetings must be communicated via our Tractus-X mailing list. Ad hoc + informal meetings may be organized without prior notice. +- __For cross-product alignments__ the Catena-X Association is currently preparing various committees to support the + coordination of the open-source products and repositories. The goal of a committee is to discuss, define and create a + common vision, roadmap, standards, architecture, KITs, etc. diff --git a/src/pages/community.mdx b/src/pages/community.mdx deleted file mode 100644 index 867a115f846..00000000000 --- a/src/pages/community.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Community ---- -import ProductOverview from '@site/src/components/ProductOverview' -import ProductAccordionCard from '@site/src/components/ProductAccordionCard' - -# Community - -We warmly welcome You to shape the automotive value chain of the next generation! - -The global Tractus-X community consists of a broad range of users, contributors, and committers from various companies (and individual actors) in the automotive value chain. We sincerely invite anyone to participate who wants to shape our architecture, reference implementations KITs for our Catena-X data space. - -## Communication Rules - -A pre-requisite for joining the Tractus-X communication channels is an Eclipse Foundation Account: https://accounts.eclipse.org/user/register?destination=user - -In addition, we encourage you to sign the Eclipse Contribution Agreement (ECA) to contribute to our Tractus-X project. For example, report and fix bugs or implement enhancements according to the Tractus-X roadmap. https://eclipse-tractusx.github.io/docs/oss/how-to-contribute - -- **For a first contact** please use our Tractus-X mailing list to get in touch with our community or a specific product team you want to contribute. tractusx-dev@eclipse.org - -- **For quick and informal syncs** please use our Matrix Chat to align on easy topics, ask questions, share a link or a bite-size piece of information. https://chat.eclipse.org/#/room/#tools.tractus-x:matrix.eclipse.org - -- **For product alignments** please set up a meeting with a tool of your choice as a project manager. The preparation of meeting minutes is not required. Recurring formal meetings must be communicated via our Tractus-X mailing list. -Ad hoc informal meetings may be organized without prior notice. - -- **For cross-product alignments** the Catena-X Association is currently preparing various committees to support the coordination of the open-source products and repositories. The goal of a committee is to discuss, define and create a common vision, roadmap, standards, architecture, KITs, etc. - -## Workflow from idea over feature proposal to PR - -![cx_workflow_idea_to_pr](@site/static/img/cx_workflow_idea_to_pr.drawio.svg) - -### How to engage and contribute to a product - -1. Get familiar with the Tractus-X project and different products (e.g. website, source code, documentation) -2. Get in contact with the product teams (e.g. [mailing list](https://eclipse-tractusx.github.io/docs/oss/how-to-contribute/#dev-mailinglist), [matrix chat](https://chat.eclipse.org/#/room/#tools.tractus-x:matrix.eclipse.org)). Ask as concrete as possible, that we can lead you to the responsible person.  -3. Start with small contributions / PRs (e.g. bug fixes) -4. Propose new features and ideas. Please align with product committers and roadmap via discussions or issues. - -### What else is needded to support and enable new contributions - -1. Quick response to mailing list, matrix chat, issues and PRs - - Tractus-X mailing list subscription needed - - Introduction of a Community Manager -2. Keep the status of your features up to date -3. Invite ( and be an active part ) to open team meetings - -
- -## Products - diff --git a/static/img/cx_workflow_idea_to_pr.drawio.svg b/static/img/cx_workflow_idea_to_pr.drawio.svg deleted file mode 100644 index b67a0e49ec0..00000000000 --- a/static/img/cx_workflow_idea_to_pr.drawio.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Committer Board(s)
Committer Board(s)
Idea
Idea
Feature
Proposal
Feature...
Discussions
Discussions
Issues
Issues
Development &
Test
Development &...
Issues aligned &
committed
Issues aligned &...
PR meet TRGs* & team specific
contributing guidlines
PR meet TRGs* & team specific...
Release
Release
Avoid (big) PRs without prior
alignment
Avoid (big) PRs without prior...Text is not SVG - cannot display \ No newline at end of file From 8ab654a7e6cedfc97a4d8cb46bc34d4423f9ae9b Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Wed, 6 Dec 2023 09:23:31 +0100 Subject: [PATCH 05/10] chore: modify community page titles --- docs/community.md | 8 ++++++-- docs/community/open-meetings.md | 4 +++- docs/community/products.mdx | 2 +- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/community.md b/docs/community.md index ae2203c77a5..a4cfc737859 100644 --- a/docs/community.md +++ b/docs/community.md @@ -1,4 +1,8 @@ -# Tractus-X community +--- +title: Intro +--- + +## Tractus-X Community We warmly welcome You to shape the automotive value chain of the next generation! The global Tractus-X community consists of a broad range of users, contributors, and committers from various companies @@ -12,7 +16,7 @@ an [Eclipse Foundation Account](https://accounts.eclipse.org/user/register?desti In addition, we encourage you to sign the Eclipse Contribution Agreement (ECA) to contribute to our Tractus-X project. For example, report and fix bugs or implement enhancements according to the Tractus-X roadmap. See -our [contributing guide](https://eclipse-tractusx.github.io/docs/oss/how-to-contribute) +our [contributing guide](https://eclipse-tractusx.github.io/docs/oss/how-to-contribute). - __For a first contact__ please use our Tractus-X mailing list (tractusx-dev@eclipse.org) to get in touch with our community or a specific product team you want to contribute. diff --git a/docs/community/open-meetings.md b/docs/community/open-meetings.md index 7c8b8130f33..a8719e0aee6 100644 --- a/docs/community/open-meetings.md +++ b/docs/community/open-meetings.md @@ -1,4 +1,6 @@ -# Eclipse Tractus-X open meetings +# Open Meetings This page hosts information about all of our open Tractus-X meetings. These are dedicated sync meetings for specific products, as well as open planning sessions. + +## Tractus-X community call diff --git a/docs/community/products.mdx b/docs/community/products.mdx index a6c27166fa5..410a845dc7d 100644 --- a/docs/community/products.mdx +++ b/docs/community/products.mdx @@ -1,5 +1,5 @@ --- -title: Tractus-X products +title: Products --- import ProductOverview from '@site/src/components/ProductOverview'; From 30c65a9835f47b3964ee4a7b704872c7d272a974 Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Tue, 12 Dec 2023 10:15:18 +0100 Subject: [PATCH 06/10] feat: add meeting minutes blog to community page --- .../2023-12-06-new-open-meeting-blog.md | 11 +++++++++++ blog-meeting-minutes/authors.yaml | 6 ++++++ docusaurus.config.js | 12 ++++++++++++ sidebars.js | 5 +++++ 4 files changed, 34 insertions(+) create mode 100644 blog-meeting-minutes/2023-12-06-new-open-meeting-blog.md create mode 100644 blog-meeting-minutes/authors.yaml diff --git a/blog-meeting-minutes/2023-12-06-new-open-meeting-blog.md b/blog-meeting-minutes/2023-12-06-new-open-meeting-blog.md new file mode 100644 index 00000000000..c10d4a8cc55 --- /dev/null +++ b/blog-meeting-minutes/2023-12-06-new-open-meeting-blog.md @@ -0,0 +1,11 @@ +--- +slug: new-open-meeting-blog +title: New Open Meeting blog +authors: + - sebastian_bezold +tags: [meeting-minutes, community] +--- + +## New home for open meeting minutes + +We are happy to announce a new blog, that will host meeting minutes of all our open meetings diff --git a/blog-meeting-minutes/authors.yaml b/blog-meeting-minutes/authors.yaml new file mode 100644 index 00000000000..c79f84e80cb --- /dev/null +++ b/blog-meeting-minutes/authors.yaml @@ -0,0 +1,6 @@ +sebastian_bezold: + name: Sebastian Bezold + title: Consortia System Team Member + url: https://github.com/SebastianBezold + image_url: https://github.com/SebastianBezold.png + diff --git a/docusaurus.config.js b/docusaurus.config.js index d06474362d8..3dcf2c9a877 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -85,6 +85,18 @@ const config = { sidebarPath: require.resolve('./sidebarsDocsProducts.js'), }, ], + [ + '@docusaurus/plugin-content-blog', + { + id: 'blog-meeting-minutes', + path: 'blog-meeting-minutes', + blogTitle: 'Open meeting minutes', + blogDescription: 'This blog hosts meeting minutes that summarize our open meetings', + routeBasePath: 'meeting-minutes', + showReadingTime: false, + authorsMapPath: 'authors.yaml' // relative path. File used is therefore /blog-meeting-minutes/authors.yaml + }, + ], // ------------DOCUSAURUS PLUGIN REMOTE CONTENT---------------- [ "docusaurus-plugin-remote-content", diff --git a/sidebars.js b/sidebars.js index 9cf40a4ffcc..fac784f5dc8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -105,6 +105,11 @@ const sidebars = { community: [ 'community', 'community/open-meetings', + { + type: 'link', + label: 'Meeting Minutes', + href: '/meeting-minutes', // see docusaurus.config.js '@docusaurus/plugin-content-blog' plugin with id: 'blog-meeting-minutes' property: 'routeBasePath:' + }, 'community/products', ], }; From e6538b1ac0ada740e8744c2ff296955c79156b0a Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Tue, 12 Dec 2023 11:26:50 +0100 Subject: [PATCH 07/10] feat: add meeting info component --- docs/community/open-meetings.md | 6 ---- docs/community/open-meetings.mdx | 13 +++++++++ src/components/MeetingInfo.jsx | 49 ++++++++++++++++++++++++++++++++ 3 files changed, 62 insertions(+), 6 deletions(-) delete mode 100644 docs/community/open-meetings.md create mode 100644 docs/community/open-meetings.mdx create mode 100644 src/components/MeetingInfo.jsx diff --git a/docs/community/open-meetings.md b/docs/community/open-meetings.md deleted file mode 100644 index a8719e0aee6..00000000000 --- a/docs/community/open-meetings.md +++ /dev/null @@ -1,6 +0,0 @@ -# Open Meetings - -This page hosts information about all of our open Tractus-X meetings. -These are dedicated sync meetings for specific products, as well as open planning sessions. - -## Tractus-X community call diff --git a/docs/community/open-meetings.mdx b/docs/community/open-meetings.mdx new file mode 100644 index 00000000000..5f312922faa --- /dev/null +++ b/docs/community/open-meetings.mdx @@ -0,0 +1,13 @@ +import MeetingInfo from '@site/src/components/MeetingInfo'; + +# Open Meetings + +This page hosts information about all of our open Tractus-X meetings. +These are dedicated sync meetings for specific products, as well as open planning sessions. + + diff --git a/src/components/MeetingInfo.jsx b/src/components/MeetingInfo.jsx new file mode 100644 index 00000000000..768274999ff --- /dev/null +++ b/src/components/MeetingInfo.jsx @@ -0,0 +1,49 @@ +import React from 'react'; + +export default function MeetingInfo({title, schedule, description, contact}) { + return ( +
+
+

{title}

+
{schedule}
+
+
+

{description}

+

Contact:

+ {contact}. +
+
+ ); +} + +const meetingInfo = { + display: 'flex', + width: '100%', + padding: '1rem 0 0.5rem' +} + +const meetingOverview = { + width: '33%', + margin: 'auto 0', + padding: '2rem 0 0.5rem', + borderRight: '2px solid #faa023' +} + +const meetingTitle = { + fontWeight: '700', + fontSize: '20px', + lineHeight: '25px' +} + +const meetingSchedule = { + fontWeight: '400', + fontSize: '12px', + lineHeight: '16px', + color: '#a5a5a5' +} + +const meetingDetails = { + width: '67%', + margin: 'auto 0', + padding: '0.5rem 1.5rem' +} From 7c53e918cd810099a28d65ea2f24c5151270094d Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Tue, 12 Dec 2023 14:59:18 +0100 Subject: [PATCH 08/10] chore: add missing copyright headers --- src/components/MeetingInfo.jsx | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/components/MeetingInfo.jsx b/src/components/MeetingInfo.jsx index 768274999ff..5644a950ecd 100644 --- a/src/components/MeetingInfo.jsx +++ b/src/components/MeetingInfo.jsx @@ -1,3 +1,21 @@ +/********************************************************************************* + * Copyright (c) 2023,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ********************************************************************************/ import React from 'react'; export default function MeetingInfo({title, schedule, description, contact}) { From d4f657abd892e6fc2bbb312a34a6059a30285e28 Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Thu, 14 Dec 2023 13:03:07 +0100 Subject: [PATCH 09/10] refactor: add dedicated community sidebar and docs folder --- docs/community.md => community/intro.md | 2 +- .../community => community}/open-meetings.mdx | 0 {docs/community => community}/products.mdx | 0 docusaurus.config.js | 25 +++++++++----- sidebars.js | 10 ------ sidebarsCommunity.js | 33 +++++++++++++++++++ 6 files changed, 50 insertions(+), 20 deletions(-) rename docs/community.md => community/intro.md (93%) rename {docs/community => community}/open-meetings.mdx (100%) rename {docs/community => community}/products.mdx (100%) create mode 100644 sidebarsCommunity.js diff --git a/docs/community.md b/community/intro.md similarity index 93% rename from docs/community.md rename to community/intro.md index a4cfc737859..21f3efc1ea3 100644 --- a/docs/community.md +++ b/community/intro.md @@ -21,7 +21,7 @@ our [contributing guide](https://eclipse-tractusx.github.io/docs/oss/how-to-cont - __For a first contact__ please use our Tractus-X mailing list (tractusx-dev@eclipse.org) to get in touch with our community or a specific product team you want to contribute. - __For quick and informal syncs__ please use - our [Matrix Chat](https://chat.eclipse.org/#/room/#tools.tractus-x:matrix.eclipse.org) to align on easy topics, ask + our [Eclipse Matrix Space](https://matrix.to/#/#automotive.tractusx:matrix.eclipse.org) to align on easy topics, ask questions, share a link or a bite-size piece of information. - __For product alignments__ please set up a meeting with a tool of your choice as a project manager. The preparation of meeting minutes is not required. Recurring formal meetings must be communicated via our Tractus-X mailing list. Ad hoc diff --git a/docs/community/open-meetings.mdx b/community/open-meetings.mdx similarity index 100% rename from docs/community/open-meetings.mdx rename to community/open-meetings.mdx diff --git a/docs/community/products.mdx b/community/products.mdx similarity index 100% rename from docs/community/products.mdx rename to community/products.mdx diff --git a/docusaurus.config.js b/docusaurus.config.js index 3dcf2c9a877..e0c9904cd50 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -85,6 +85,7 @@ const config = { sidebarPath: require.resolve('./sidebarsDocsProducts.js'), }, ], + // -- Community -- [ '@docusaurus/plugin-content-blog', { @@ -92,11 +93,23 @@ const config = { path: 'blog-meeting-minutes', blogTitle: 'Open meeting minutes', blogDescription: 'This blog hosts meeting minutes that summarize our open meetings', - routeBasePath: 'meeting-minutes', + blogSidebarCount: 10, + blogSidebarTitle: "Recent meetings", + routeBasePath: 'community/meeting-minutes', showReadingTime: false, authorsMapPath: 'authors.yaml' // relative path. File used is therefore /blog-meeting-minutes/authors.yaml }, ], + [ + '@docusaurus/plugin-content-docs', + { + id: 'docs-community', + path: 'community', + routeBasePath: 'community', + editUrl: 'https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/community', + sidebarPath: './sidebarsCommunity.js', + }, + ], // ------------DOCUSAURUS PLUGIN REMOTE CONTENT---------------- [ "docusaurus-plugin-remote-content", @@ -397,10 +410,9 @@ const config = { label: 'Tutorials', }, { - type: 'doc', - docId: 'community', - position: 'left', + to: '/community/intro', label: 'Community', + position: 'left', }, { type: 'dropdown', @@ -417,11 +429,6 @@ const config = { }, ], }, - // { - // to: "/docs-products/category/products", - // position: "left", - // label: "Products", - // }, { type: 'docsVersionDropdown', docsPluginId: 'docs-kits', diff --git a/sidebars.js b/sidebars.js index fac784f5dc8..cf5d2ca75da 100644 --- a/sidebars.js +++ b/sidebars.js @@ -102,16 +102,6 @@ const sidebars = { ], }, ], - community: [ - 'community', - 'community/open-meetings', - { - type: 'link', - label: 'Meeting Minutes', - href: '/meeting-minutes', // see docusaurus.config.js '@docusaurus/plugin-content-blog' plugin with id: 'blog-meeting-minutes' property: 'routeBasePath:' - }, - 'community/products', - ], }; module.exports = sidebars; diff --git a/sidebarsCommunity.js b/sidebarsCommunity.js new file mode 100644 index 00000000000..cd56a42c1f9 --- /dev/null +++ b/sidebarsCommunity.js @@ -0,0 +1,33 @@ +/******************************************************************************* + * Copyright (c) 2023,2024 Contributors to the Eclipse Foundation + * + * See the NOTICE file(s) distributed with this work for additional + * information regarding copyright ownership. + * + * This program and the accompanying materials are made available under the + * terms of the Apache License, Version 2.0 which is available at + * https://www.apache.org/licenses/LICENSE-2.0. + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + * SPDX-License-Identifier: Apache-2.0 + ******************************************************************************/ + +const sidebars = { + community: [ + 'intro', + 'open-meetings', + 'products', + { + type: 'link', + label: 'Meeting Minutes', + href: '/community/meeting-minutes', // see docusaurus.config.js '@docusaurus/plugin-content-blog' plugin with id: 'blog-meeting-minutes' property: 'routeBasePath:' + }, + ], +}; + +module.exports = sidebars; From 6e8dd59d93b385cc5a3d3114eef15a1c06f8e7cd Mon Sep 17 00:00:00 2001 From: Sebastian Bezold Date: Thu, 14 Dec 2023 13:33:21 +0100 Subject: [PATCH 10/10] feat: add client-side redirect for community --- DEPENDENCIES | 3 ++- docusaurus.config.js | 13 +++++++++++++ package-lock.json | 40 ++++++++++++++++++++++++++++++++++++++++ package.json | 1 + 4 files changed, 56 insertions(+), 1 deletion(-) diff --git a/DEPENDENCIES b/DEPENDENCIES index 6cc0648e12f..2801414ada6 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -160,7 +160,7 @@ npm/npmjs/-/cssnano-preset-default/5.2.13, MIT, approved, clearlydefined npm/npmjs/-/cssnano-utils/3.1.0, MIT, approved, clearlydefined npm/npmjs/-/cssnano/5.1.14, MIT, approved, clearlydefined npm/npmjs/-/csso/4.2.0, MIT, approved, clearlydefined -npm/npmjs/-/csstype/3.1.1, MIT, approved, clearlydefined +npm/npmjs/-/csstype/3.1.1, MIT, approved, #11847 npm/npmjs/-/cytoscape-cose-bilkent/4.1.0, MIT, approved, clearlydefined npm/npmjs/-/cytoscape-fcose/2.2.0, MIT, approved, clearlydefined npm/npmjs/-/cytoscape/3.26.0, MIT, approved, clearlydefined @@ -1165,6 +1165,7 @@ npm/npmjs/@docusaurus/cssnano-preset/2.2.0, MIT, approved, clearlydefined npm/npmjs/@docusaurus/logger/2.2.0, MIT, approved, clearlydefined npm/npmjs/@docusaurus/mdx-loader/2.2.0, MIT, approved, clearlydefined npm/npmjs/@docusaurus/module-type-aliases/2.2.0, MIT, approved, clearlydefined +npm/npmjs/@docusaurus/plugin-client-redirects/2.2.0, MIT, approved, clearlydefined npm/npmjs/@docusaurus/plugin-content-blog/2.2.0, MIT, approved, clearlydefined npm/npmjs/@docusaurus/plugin-content-docs/2.2.0, MIT, approved, clearlydefined npm/npmjs/@docusaurus/plugin-content-pages/2.2.0, MIT, approved, clearlydefined diff --git a/docusaurus.config.js b/docusaurus.config.js index e0c9904cd50..034caf388b1 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -110,6 +110,19 @@ const config = { sidebarPath: './sidebarsCommunity.js', }, ], + [ + // HINT: won't redirect in local dev mode (npm start). See: https://docusaurus.io/docs/2.x/api/plugins/@docusaurus/plugin-client-redirects + // to test, use npm run build && npm run serve + '@docusaurus/plugin-client-redirects', + { + redirects: [ + { + to: '/community/intro', + from: '/community', + }, + ], + }, + ], // ------------DOCUSAURUS PLUGIN REMOTE CONTENT---------------- [ "docusaurus-plugin-remote-content", diff --git a/package-lock.json b/package-lock.json index b3f3953b813..d8fcf6ff7a1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,6 +9,7 @@ "version": "0.0.0", "dependencies": { "@docusaurus/core": "2.2.0", + "@docusaurus/plugin-client-redirects": "^2.2.0", "@docusaurus/preset-classic": "2.2.0", "@docusaurus/theme-mermaid": "2.2.0", "@emotion/react": "^11.10.5", @@ -2187,6 +2188,29 @@ "react-dom": "*" } }, + "node_modules/@docusaurus/plugin-client-redirects": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-2.2.0.tgz", + "integrity": "sha512-psBoWi+cbc2I+VPkKJlcZ12tRN3xiv22tnZfNKyMo18iSY8gr4B6Q0G2KZXGPgNGJ/6gq7ATfgDK6p9h9XRxMQ==", + "dependencies": { + "@docusaurus/core": "2.2.0", + "@docusaurus/logger": "2.2.0", + "@docusaurus/utils": "2.2.0", + "@docusaurus/utils-common": "2.2.0", + "@docusaurus/utils-validation": "2.2.0", + "eta": "^1.12.3", + "fs-extra": "^10.1.0", + "lodash": "^4.17.21", + "tslib": "^2.4.0" + }, + "engines": { + "node": ">=16.14" + }, + "peerDependencies": { + "react": "^16.8.4 || ^17.0.0", + "react-dom": "^16.8.4 || ^17.0.0" + } + }, "node_modules/@docusaurus/plugin-content-blog": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-2.2.0.tgz", @@ -18217,6 +18241,22 @@ "react-loadable": "npm:@docusaurus/react-loadable@5.5.2" } }, + "@docusaurus/plugin-client-redirects": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-2.2.0.tgz", + "integrity": "sha512-psBoWi+cbc2I+VPkKJlcZ12tRN3xiv22tnZfNKyMo18iSY8gr4B6Q0G2KZXGPgNGJ/6gq7ATfgDK6p9h9XRxMQ==", + "requires": { + "@docusaurus/core": "2.2.0", + "@docusaurus/logger": "2.2.0", + "@docusaurus/utils": "2.2.0", + "@docusaurus/utils-common": "2.2.0", + "@docusaurus/utils-validation": "2.2.0", + "eta": "^1.12.3", + "fs-extra": "^10.1.0", + "lodash": "^4.17.21", + "tslib": "^2.4.0" + } + }, "@docusaurus/plugin-content-blog": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/@docusaurus/plugin-content-blog/-/plugin-content-blog-2.2.0.tgz", diff --git a/package.json b/package.json index befa1cba1a7..bf5b89e3c54 100644 --- a/package.json +++ b/package.json @@ -17,6 +17,7 @@ }, "dependencies": { "@docusaurus/core": "2.2.0", + "@docusaurus/plugin-client-redirects": "^2.2.0", "@docusaurus/preset-classic": "2.2.0", "@docusaurus/theme-mermaid": "2.2.0", "@emotion/react": "^11.10.5",