Skip to content

Commit cb1d498

Browse files
authored
docs: update SUPPORT.md and add link in sidebar (#107)
Signed-off-by: Nora Blomaard <[email protected]>
1 parent 55a88c4 commit cb1d498

File tree

3 files changed

+56
-19
lines changed

3 files changed

+56
-19
lines changed

SUPPORT.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/SUPPORT.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Support
2+
3+
## Voluntary Support Channels
4+
5+
### LF Energy Slack
6+
7+
Join the LF Energy Slack workspace to connect with the CoMPAS community:
8+
9+
- **Workspace**: [LF Energy Slack](https://lfenergy.slack.com/)
10+
- **Channel**: `#compas`
11+
12+
### Github Issues
13+
14+
For bug reports, feature requests or questions, please use GitHub Issues in the relevant repository, for example:
15+
16+
- [CoMPAS Open SCD Issues](https://github.com/com-pas/compas-open-scd/issues)
17+
- [CoMPAS SCL Data Service Issues](https://github.com/com-pas/compas-scl-data-service/issues)
18+
- [CoMPAS CIM Mapping Issues](https://github.com/com-pas/compas-cim-mapping/issues)
19+
- [CoMPAS Core Issues](https://github.com/com-pas/compas-core/issues)
20+
21+
_For a complete list of all CoMPAS repositories, visit the [CoMPAS GitHub organization](https://github.com/com-pas)._
22+
23+
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.
24+
25+
#### Security Vulnerabilities
26+
27+
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.
28+
29+
**Security Advisory Links per Repository (examples):**
30+
31+
- [CoMPAS Open SCD Security Advisories](https://github.com/com-pas/compas-open-scd/security/advisories)
32+
- [CoMPAS SCL Data Service Security Advisories](https://github.com/com-pas/compas-scl-data-service/security/advisories)
33+
- [CoMPAS CIM Mapping Security Advisories](https://github.com/com-pas/compas-cim-mapping/security/advisories)
34+
- [CoMPAS Core Security Advisories](https://github.com/com-pas/compas-core/security/advisories)
35+
36+
_For security advisories for all other CoMPAS repositories, navigate to the specific repository and access the Security tab._
37+
38+
### Useful Links
39+
40+
- Website: [CoMPAS - LF Energy](https://www.lfenergy.org/projects/compas/)
41+
- [Artwork](https://github.com/lf-energy/artwork/tree/main/projects/compas)
42+
- Mailing lists:
43+
- [CoMPAS](https://lists.lfenergy.org/g/CoMPAS)
44+
- [CoMPAS-dev](https://lists.lfenergy.org/g/CoMPAS-dev)
45+
- [CoMPAS-tsc](https://lists.lfenergy.org/g/CoMPAS-tsc)
46+
- [Calender](https://zoom-lfx.platform.linuxfoundation.org/meetings/compas)
47+
48+
## Professional Services
49+
50+
The following companies provide commercial support for CoMPAS:
51+
52+
- [BearingPoint](https://www.bearingpoint.com/)
53+
- [SprintEins](https://sprinteins.com/)

docs/_includes/sidebar.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ <h2>
4545
<li class="nav-list-item">
4646
<a class="sidebar-nav-item{% if page.url == '/MONITORING.html' %} active{% endif %}" href="{{ site.baseurl }}/MONITORING.html">Monitoring</a>
4747
</li>
48+
<li class="nav-list-item">
49+
<a class="sidebar-nav-item{% if page.url == '/SUPPORT.html' %} active{% endif %}" href="{{ site.baseurl }}/SUPPORT.html">Support</a>
50+
</li>
4851
</ul>
4952
</nav>
5053

0 commit comments

Comments
 (0)