Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add "Getting support" page covering EESSI support portal #109

Merged
merged 12 commits into from
Oct 2, 2023
Merged

add "Getting support" page covering EESSI support portal #109

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
3883dfc
adding support page
laraPPr Aug 7, 2023
d7cfc69
Update support.md
laraPPr Aug 7, 2023
315cdd6
Update support.md
laraPPr Aug 7, 2023
827a46b
Update support.md
laraPPr Aug 9, 2023
047d6d1
Update support.md
laraPPr Aug 10, 2023
cb410b5
Update support.md
laraPPr Aug 10, 2023
59777f8
Update support.md
laraPPr Aug 10, 2023
03cd256
Update support.md
laraPPr Aug 11, 2023
204eee3
Update support.md
laraPPr Sep 4, 2023
54fa71c
Update support.md
laraPPr Sep 26, 2023
f69ea8b
add page title, centre MultiXscale logo, add remark on open source li…
boegel Oct 2, 2023
f733d05
add more prominent link to EESSI support portal
boegel Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/img/logos/multixscale_logo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ More details about the project are available in the different subsections:
* [Getting access to EESSI](getting_access/is_eessi_accessible.md)
* [Using EESSI](using_eessi/setting_up_environment.md)
* [Software testing](software_testing.md)
* [Getting support](support.md)
* [Meetings](meetings.md)
* [Project partners](partners.md)
* [Contact info](contact.md)
Expand Down
40 changes: 40 additions & 0 deletions docs/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
![MustiXscale logo](img/logos/multixscale_logo.png){width=60%}

Thanks to the MultiXscale project we are able to provide support to the users of EESSI.
The support portal is supported by GitLab.

## How to report a problem or ask a question

We recommend you to get a GitLab account for all your support needs.

If you have a GitLab account you can submit your problems or questions on
the following GitLab repo, https://gitlab.com/eessi/support.
Please use one of the provided templates (report a problem, software request, question) when submitting an issue.

You can also submit your issues or send in questions via our e-mail address `support (@) eessi.io`.
When you send us an email, please provide us with as much information as possible on the issue that you are having.
You can find lists on the information that we would like to receive in the ReadMe of the GitLab repository.

## What do we support

### Getting access the EESSI software stack
If you have trouble connecting to the software stack.
Such as trouble related the [cernVM-FS filesystem layer](filesystem_layer.md) or the [compat layers](compatibility_layer.md).
Please contact us.

### software requests
laraPPr marked this conversation as resolved.
Show resolved Hide resolved
We are open to software requests for applications that aren't available. You can try it your self by looking through the [documentation on adding software](software_layer/adding_software.md).
Or you can just send in a request.
Please try to provide as much information on the software as possible.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Please try to provide as much information on the software as possible.
Please try to provide as much information on the software as possible, and be aware that we can only provide software that has an appropriate open source license.


### Test-suite
If you are using the test-suite and run into any trouble using it you can also sent them in via our GitLab support portal or email.
laraPPr marked this conversation as resolved.
Show resolved Hide resolved

### Using the software
Please report any problems that you encounter when using software in the EESSI stack that are specifically related to the installation within EESSI.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This probably needs some more level of detail, like example of what we would support, and something we would not.


## What do we not support

We ask the users of EESSI to refrain from sending in issues that are specifically related to helping them use certain software that EESSI provides.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We ask the users of EESSI to refrain from sending in issues that are specifically related to helping them use certain software that EESSI provides.
We ask the users of EESSI to refrain from sending in issues that are specifically related to
helping them use certain software that EESSI provides. EESSI does not the capacity to have expertise
on all the software that it provides and you are more likely to get better support from the software
project itself.

Please consult the documentation and the support that accompanies the software in question.

1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ nav:
- using_eessi/basic_commands.md
- using_eessi/eessi_demos.md
- Software testing: software_testing.md
- Getting support: support.md
- Meetings:
- Overview: meetings.md
- Community meeting (Sept'22): meetings/2022-09-amsterdam.md
Expand Down