From abfe7ab22605a4747ab2f660f8a7078bb033f289 Mon Sep 17 00:00:00 2001 From: Nora Blomaard Date: Wed, 16 Jul 2025 11:11:00 +0200 Subject: [PATCH 1/3] docs: update SUPPORT.md and add link in sidebar Signed-off-by: Nora Blomaard --- SUPPORT.md | 19 ------------------ docs/SUPPORT.md | 39 +++++++++++++++++++++++++++++++++++++ docs/_includes/sidebar.html | 3 +++ 3 files changed, 42 insertions(+), 19 deletions(-) delete mode 100644 SUPPORT.md create mode 100644 docs/SUPPORT.md diff --git a/SUPPORT.md b/SUPPORT.md deleted file mode 100644 index ed64f24..0000000 --- a/SUPPORT.md +++ /dev/null @@ -1,19 +0,0 @@ -# Support - -Support can consist of voluntairy open source project support or commercial support. - -Their are multiple ways to reach out for volutairy community support: -- File Github issues -- Join one of the meetings -- LF energy slack channel - - -## _Key Links_ - -- Website: [CoMPAS - LF Energy](https://www.compas.energy/) -- [Artwork](https://github.com/lf-energy/artwork/tree/main/projects/compas) -- Mailing lists: - - [CoMPAS](https://lists.lfenergy.org/g/CoMPAS) - - [CoMPAS-tsc](https://lists.lfenergy.org/g/CoMPAS-tsc) -- [slack](https://lfenergy.slack.com/) (find the #COMPAS channel) -- [Calender](https://zoom-lfx.platform.linuxfoundation.org/meetings/compas) diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md new file mode 100644 index 0000000..87aee66 --- /dev/null +++ b/docs/SUPPORT.md @@ -0,0 +1,39 @@ +# Support + +## Voluntary Support Channels + +### LF Energy Slack + +Join the LF Energy Slack workspace to connect with the CoMPAS community: + +- **Workspace**: [LF Energy Slack](https://lfenergy.slack.com/) +- **Channel**: `#compas` + +### Github Issues + +For bug reports, feature requests, and security vulnerabilities, please use GitHub Issues in the relevant repository: + +- [CoMPAS Open SCD Issues](https://github.com/com-pas/compas-open-scd/issues) +- [CoMPAS SCL Data Service Issues](https://github.com/com-pas/compas-scl-data-service/issues) +- [CoMPAS CIM Mapping Issues](https://github.com/com-pas/compas-cim-mapping/issues) +- [CoMPAS SCL Validator Issues](https://github.com/com-pas/compas-scl-validator/issues) +- [CoMPAS Core Issues](https://github.com/com-pas/compas-core/issues) + +When creating an issue, please use the appropriate issue template (bug report, feature request, etc.) and provide all the requested information. This helps maintainers understand and address your issue more efficiently. + +### Useful Links + +- Website: [CoMPAS - LF Energy](https://www.lfenergy.org/projects/compas/) +- [Artwork](https://github.com/lf-energy/artwork/tree/main/projects/compas) +- Mailing lists: + - [CoMPAS](https://lists.lfenergy.org/g/CoMPAS) + - [CoMPAS-dev](https://lists.lfenergy.org/g/CoMPAS-dev) + - [CoMPAS-tsc](https://lists.lfenergy.org/g/CoMPAS-tsc) +- [Calender](https://zoom-lfx.platform.linuxfoundation.org/meetings/compas) + +## Professional Services + +The following companies provide commercial support for CoMPAS: + +* [BearingPoint](https://www.bearingpoint.com/) +* [SprintEins](https://sprinteins.com/) diff --git a/docs/_includes/sidebar.html b/docs/_includes/sidebar.html index 18710a1..526cac0 100644 --- a/docs/_includes/sidebar.html +++ b/docs/_includes/sidebar.html @@ -45,6 +45,9 @@

  • Monitoring
    • +
  • + Support +
    • From eea09b2429fdf5aa083f5eca07892a71460f1ca1 Mon Sep 17 00:00:00 2001 From: Nora Blomaard Date: Wed, 16 Jul 2025 13:27:30 +0200 Subject: [PATCH 2/3] docs: enhance SUPPORT.md with security vulnerability reporting and additional issue links --- docs/SUPPORT.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md index 87aee66..b1aebf4 100644 --- a/docs/SUPPORT.md +++ b/docs/SUPPORT.md @@ -11,16 +11,38 @@ Join the LF Energy Slack workspace to connect with the CoMPAS community: ### Github Issues -For bug reports, feature requests, and security vulnerabilities, please use GitHub Issues in the relevant repository: +For bug reports, feature requests or questions, please use GitHub Issues in the relevant repository: - [CoMPAS Open SCD Issues](https://github.com/com-pas/compas-open-scd/issues) - [CoMPAS SCL Data Service Issues](https://github.com/com-pas/compas-scl-data-service/issues) - [CoMPAS CIM Mapping Issues](https://github.com/com-pas/compas-cim-mapping/issues) - [CoMPAS SCL Validator Issues](https://github.com/com-pas/compas-scl-validator/issues) +- [CoMPAS SCL Auto Alignment Issues](https://github.com/com-pas/compas-scl-auto-alignment/issues) - [CoMPAS Core Issues](https://github.com/com-pas/compas-core/issues) +- [CoMPAS SCT Issues](https://github.com/com-pas/compas-sct/issues) +- [CoMPAS SCL XSD Issues](https://github.com/com-pas/compas-scl-xsd/issues) +- [CoMPAS Deployment Issues](https://github.com/com-pas/compas-deployment/issues) +- [CoMPAS Architecture Issues](https://github.com/com-pas/compas-architecture/issues) When creating an issue, please use the appropriate issue template (bug report, feature request, etc.) and provide all the requested information. This helps maintainers understand and address your issue more efficiently. +#### Security Vulnerabilities + +If you discover a security vulnerability in any CoMPAS component, please report it (privately) through GitHub Security Advisories. Our contributors aim to respond within one week of your report with an acknowledgment and a preliminary plan for addressing the issue, including any necessary fixes and additional security tests. + +**Security Advisory Links per Repository:** + +- [CoMPAS Open SCD Security Advisories](https://github.com/com-pas/compas-open-scd/security/advisories) +- [CoMPAS SCL Data Service Security Advisories](https://github.com/com-pas/compas-scl-data-service/security/advisories) +- [CoMPAS CIM Mapping Security Advisories](https://github.com/com-pas/compas-cim-mapping/security/advisories) +- [CoMPAS SCL Validator Security Advisories](https://github.com/com-pas/compas-scl-validator/security/advisories) +- [CoMPAS SCL Auto Alignment Security Advisories](https://github.com/com-pas/compas-scl-auto-alignment/security/advisories) +- [CoMPAS Core Security Advisories](https://github.com/com-pas/compas-core/security/advisories) +- [CoMPAS SCT Security Advisories](https://github.com/com-pas/compas-sct/security/advisories) +- [CoMPAS SCL XSD Security Advisories](https://github.com/com-pas/compas-scl-xsd/security/advisories) +- [CoMPAS Deployment Security Advisories](https://github.com/com-pas/compas-deployment/security/advisories) +- [CoMPAS Architecture Security Advisories](https://github.com/com-pas/compas-architecture/security/advisories) + ### Useful Links - Website: [CoMPAS - LF Energy](https://www.lfenergy.org/projects/compas/) @@ -35,5 +57,5 @@ When creating an issue, please use the appropriate issue template (bug report, f The following companies provide commercial support for CoMPAS: -* [BearingPoint](https://www.bearingpoint.com/) -* [SprintEins](https://sprinteins.com/) +- [BearingPoint](https://www.bearingpoint.com/) +- [SprintEins](https://sprinteins.com/) From b8f3ff94c2a744ca621c4d0fe56edac053c986ee Mon Sep 17 00:00:00 2001 From: Nora Blomaard Date: Wed, 16 Jul 2025 14:44:19 +0200 Subject: [PATCH 3/3] docs: implement review comments --- docs/SUPPORT.md | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md index b1aebf4..448e924 100644 --- a/docs/SUPPORT.md +++ b/docs/SUPPORT.md @@ -11,18 +11,14 @@ Join the LF Energy Slack workspace to connect with the CoMPAS community: ### Github Issues -For bug reports, feature requests or questions, please use GitHub Issues in the relevant repository: +For bug reports, feature requests or questions, please use GitHub Issues in the relevant repository, for example: - [CoMPAS Open SCD Issues](https://github.com/com-pas/compas-open-scd/issues) - [CoMPAS SCL Data Service Issues](https://github.com/com-pas/compas-scl-data-service/issues) - [CoMPAS CIM Mapping Issues](https://github.com/com-pas/compas-cim-mapping/issues) -- [CoMPAS SCL Validator Issues](https://github.com/com-pas/compas-scl-validator/issues) -- [CoMPAS SCL Auto Alignment Issues](https://github.com/com-pas/compas-scl-auto-alignment/issues) - [CoMPAS Core Issues](https://github.com/com-pas/compas-core/issues) -- [CoMPAS SCT Issues](https://github.com/com-pas/compas-sct/issues) -- [CoMPAS SCL XSD Issues](https://github.com/com-pas/compas-scl-xsd/issues) -- [CoMPAS Deployment Issues](https://github.com/com-pas/compas-deployment/issues) -- [CoMPAS Architecture Issues](https://github.com/com-pas/compas-architecture/issues) + +_For a complete list of all CoMPAS repositories, visit the [CoMPAS GitHub organization](https://github.com/com-pas)._ When creating an issue, please use the appropriate issue template (bug report, feature request, etc.) and provide all the requested information. This helps maintainers understand and address your issue more efficiently. @@ -30,18 +26,14 @@ When creating an issue, please use the appropriate issue template (bug report, f If you discover a security vulnerability in any CoMPAS component, please report it (privately) through GitHub Security Advisories. Our contributors aim to respond within one week of your report with an acknowledgment and a preliminary plan for addressing the issue, including any necessary fixes and additional security tests. -**Security Advisory Links per Repository:** +**Security Advisory Links per Repository (examples):** - [CoMPAS Open SCD Security Advisories](https://github.com/com-pas/compas-open-scd/security/advisories) - [CoMPAS SCL Data Service Security Advisories](https://github.com/com-pas/compas-scl-data-service/security/advisories) - [CoMPAS CIM Mapping Security Advisories](https://github.com/com-pas/compas-cim-mapping/security/advisories) -- [CoMPAS SCL Validator Security Advisories](https://github.com/com-pas/compas-scl-validator/security/advisories) -- [CoMPAS SCL Auto Alignment Security Advisories](https://github.com/com-pas/compas-scl-auto-alignment/security/advisories) - [CoMPAS Core Security Advisories](https://github.com/com-pas/compas-core/security/advisories) -- [CoMPAS SCT Security Advisories](https://github.com/com-pas/compas-sct/security/advisories) -- [CoMPAS SCL XSD Security Advisories](https://github.com/com-pas/compas-scl-xsd/security/advisories) -- [CoMPAS Deployment Security Advisories](https://github.com/com-pas/compas-deployment/security/advisories) -- [CoMPAS Architecture Security Advisories](https://github.com/com-pas/compas-architecture/security/advisories) + +_For security advisories for all other CoMPAS repositories, navigate to the specific repository and access the Security tab._ ### Useful Links