Skip to content

Commit

Permalink
docs: Promote GitHub Discussion, retire HackMD
Browse files Browse the repository at this point in the history
We are moving to GitHub Discussions as the primary location for usage,
feature, and roadmap discussion.

Promote it via updated links. The singularityce-community repo, which
is managed via HackMD, will have redirection notices added.
  • Loading branch information
dtrudg committed May 3, 2023
1 parent 65858fd commit 9842eb3
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 47 deletions.
28 changes: 12 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

- [Documentation](https://www.sylabs.io/docs/)
- [Getting Support](#support)
- [Community Meetings / Minutes / Roadmap](https://github.com/sylabs/singularityce-community)
- [Monthly Community Call](https://github.com/sylabs/singularity/discussions/categories/community-call)
- [Roadmap](https://github.com/sylabs/singularity/discussions/categories/roadmap)
- [Project License](LICENSE.md)
- [Guidelines for Contributing](CONTRIBUTING.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
Expand Down Expand Up @@ -52,8 +53,7 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md). Please follow it in
all your interactions with the project members and users.

Our roadmap, other documents, and user/developer meeting information can be
found in the
[singularityce-community repository](https://github.com/sylabs/singularityce-community).
found in [GitHub Discussions](https://github.com/sylabs/singularity/discussions/).

We also welcome contributions to our
[user guide](https://github.com/sylabs/singularity-userdocs) and
Expand All @@ -62,10 +62,7 @@ We also welcome contributions to our
## Support

To get help with SingularityCE, check out the community spaces detailed at our
[Community Portal](https://sylabs.io/singularity#community), or the
[SingularityCE Community
Repository](https://github.com/sylabs/singularityce-community), which also
houses our open roadmap, and meeting information.
[Community Portal](https://sylabs.io/singularity#community).

See also our [Support Guidelines](SUPPORT.md) for further information about the
best place, and how, to raise different kinds of issues and questions.
Expand All @@ -75,20 +72,19 @@ more information.

## Community Calls & Roadmap

We maintain our roadmap as an open living document in our [SingularityCE
Community
Repository](https://github.com/sylabs/singularityce-community/blob/main/roadmap.md).
Users and interested developers are welcome to add to, and comment on the
roadmap via HackMD.
We maintain our roadmap on [GitHub
Discussions](https://github.com/sylabs/singularity/discussions/categories/roadmap),
so that it's easy to collect ideas for new features, and discuss which should be
prioritized for the next release.

Regular community calls are held for the project, on the first Thursday of each
month, via Zoom. The agenda for each call includes a demonstration of new
features, or a project / workflow related to SingularityCE. This is followed by
development updates & discussion, before open questions. Meeting details are
posted in our [SingularityCE Community
Repository](https://github.com/sylabs/singularityce-community), and recordings
at the [Sylabs YouTube
Channel](https://www.youtube.com/channel/UCsxpqAJKGJBMEFHFr-5VL2w).
posted in [Github
Discussions](https://github.com/sylabs/singularity/discussions/categories/community-call),
and recordings made available at the [Sylabs YouTube
Channel](https://www.youtube.com/c/SylabsInc/videos).

If you work on a project related to Singularity, or use Singularity in an
interesting workflow, [let us know](mailto:[email protected]) if you'd like to
Expand Down
89 changes: 58 additions & 31 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,79 @@
# SingularityCE Support

SingularityCE is a community focused open source project. We maintain
documentation, which everyone is welcome and encourage to contribute to. We have
a number of spaces in which questions can be asked, and problems reported.
[documentation](#documentation), which everyone is welcomed and encouraged to
contribute to. We have a number of spaces, maintained by the project, in which
questions can be asked and problems reported.

- [GitHub Discussions](#github-discussions) - Usage questions, discussions, and announcements.
- [Google Group / Mailing List](#google-group--mailing-list) - Usage questions,
discussions, and announcements.
- [Slack](#slack) - Real time chat.
- [GitHub Issues](#github-issues) - Bug reports & feature requests.
- [Community Calls](#community-calls) - Development updates and discussion.

## Documentation

If you haven't already, read our [documentation](https://www.sylabs.io/docs/).
These docs cover common use cases, and are often helpful to browse before
submitting an issue or asking a question to the community.
If you haven't already, please read our
[documentation](https://www.sylabs.io/docs/). The user and admin focused docs
cover common use cases, and are often helpful to browse before submitting an
issue or asking a question to the community.

The documentation is under an open source license, and we encourage everyone to
contribute via the GitHub repositories.
The documentation is released under an open source license, and we encourage
contributions via the GitHub repositories:

- [singularity-admindocs](https://github.com/sylabs/singularity-admindocs) and
- [singularity-admindocs](https://github.com/sylabs/singularity-admindocs)
- [singularity-userdocs](https://github.com/sylabs/singularity-userdocs)
repositories.

## Github
## GitHub Discussions

[GitHub Discussions](https://github.com/sylabs/singularity/discussions) on the
SingularityCE repository provides a convenient place to reach the user and
developer community, and:

- Ask usage questions.
- Suggest, discuss, and develop ideas for new features.
- Provide input into the SingularityCE development roadmap.
- Keep up-to-date with releases and community calls.

As a searchable and permanent archive of questions and discussion, we encourage
you to use GitHub discussions to reach the broadest audience of SingularityCE
users and developers.

## Google Group / Mailing List

If you prefer a more traditional mailing list for announcements and discussions,
you can subscribe to the low volume [Google
Group](https://groups.google.com/g/singularity-ce).

## Slack

For real time conversation with the community, you can join our Slack -
[singularityce.slack.com](https://singularityce.slack.com/). An up-to-date
direct invite link can be found at the [Sylabs
website](https://sylabs.io/singularity/).

Note that the Slack is hosted under a free plan, with limited retention of
conversation history. Please use [GitHub
Discussions](https://github.com/sylabs/singularity/discussions) when a
searchable permanent archive would beneficial.

## Github Issues

For bugs, feature requests, and other technical issues we recommend opening a
new issue on the Github issues boards.

- [SingularityCE Issues](https://github.com/sylabs/singularity/issues): is
recommended for most issues with the SingularityiCE software itself.
recommended for most issues with the SingularityCE software itself.
- [User Documentation](https://github.com/sylabs/singularity-userdocs/issues)
questions, feedback, and suggestions should go here.
- [Admin Documentation](https://github.com/sylabs/singularity-admindocs/issues)
questions, feedback, and suggestions should go here.

Note that usage questions, or problems related to running a specific piece of
software in a container, are best asked on the Google Group, or Slack channel.
Questions in these venues will be seen by a greater number of users, who may
already know the answer!
software in a container, are best asked on GitHub Discussions, the Google Group,
or in the Slack channel. Questions in these venues will be seen by a greater
number of users, who may already know the answer!

### How should I create an issue?

Expand Down Expand Up @@ -88,26 +129,12 @@ review some of these reasons, along with strategies for managing them:
imperfect or incomplete, can often provided the momentum needed to get a fix
or enhancement rolling.

## Google Group

You can reach the community quickly by way of joining our
[Google Group](https://groups.google.com/g/singularity-ce).

## Slack

For real time conversation with the community, you can join our Slack at
[https://singularityce.slack.com/](https://singularityce.slack.com/). Ping the
Google Group or one of the admins here to request to be added.

## Community Calls

Regular community calls are held for the project, on the first Thursday of each
month, via Zoom. These calls are an excellent place to raise feature suggestions
or kick-off discussion about something you'd like to see in SingularityCE.
Meeting details are posted in our [SingularityCE Community
Repository](https://github.com/sylabs/singularityce-community), and recordings
at the [Sylabs YouTube
Meeting details are posted in [GitHub
Discussions](https://github.com/sylabs/singularity/discussions/categories/community-call),
and recordings at the [Sylabs YouTube
Channel](https://www.youtube.com/channel/UCsxpqAJKGJBMEFHFr-5VL2w).

Is there something missing here you'd like to see? Please
[let us know](https://github.com/sylabs/singularity/issues).

0 comments on commit 9842eb3

Please sign in to comment.