From 5bc41409bb4d1473257cd3ba8937e57a7830591d Mon Sep 17 00:00:00 2001 From: Dave Dykstra Date: Tue, 8 Feb 2022 15:17:44 -0600 Subject: [PATCH] remove hpcng from md files, update INSTALL.md for 3.8.6 --- CONTRIBUTING.md | 6 +++--- INSTALL.md | 20 ++++++++++---------- README.md | 22 +++++++++++----------- SUPPORT.md | 12 ++++++------ 4 files changed, 30 insertions(+), 30 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce7aeaafdd..8a4aebef5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,12 +63,12 @@ all your interactions with the project members and users. additions to `go.mod` should explain why the dependency is required. ## Documentation -There are a few places where documentation for the Singularity project lives. The [changelog](CHANGELOG.md) is where PRs should include documentation if necessary. When a new release is tagged, the [user-docs](https://singularity.hpcng.org/user-docs/master/) and [admin-docs](https://singularity.hpcng.org/admin-docs/master/) will be updated using the contents of the `CHANGELOG.md` file as reference. +There are a few places where documentation for the Singularity project lives. The [changelog](CHANGELOG.md) is where PRs should include documentation if necessary. When a new release is tagged, the [user-docs](https://apptainer.org/user-docs/master/) and [admin-docs](https://apptainer.org/admin-docs/master/) will be updated using the contents of the `CHANGELOG.md` file as reference. 1. The [changelog](CHANGELOG.md) is a place to document **functional** differences between versions of Singularity. PRs which require documentation must update this file. This should be a document which can be used to explain what the new features of each version of Singularity are, and should **not** read like a commit log. Once a release is tagged (*e.g. v3.0.0*), a new top level section will be made titled **Changes Since vX.Y.Z** (*e.g. Changes Since v3.0.0*) where new changes will now be documented, leaving the previous section immutable. 2. The [README](README.md) is a place to document critical information for new users of Singularity. It should typically not change, but in the case where a change is necessary a PR may update it. -3. The [user-docs](https://www.github.com/hpcng/singularity-userdocs) should document anything pertinent to the usage of Singularity. -4. The [admin-docs](https://www.github.com/hpcng/singularity-admindocs) document anything that is pertinent to a system administrator who manages a system with Singularity installed. +3. The [user-docs](https://www.github.com/apptainer/singularity-userdocs) should document anything pertinent to the usage of Singularity. +4. The [admin-docs](https://www.github.com/apptainer/singularity-admindocs) document anything that is pertinent to a system administrator who manages a system with Singularity installed. 5. If necessary, changes to the message displayed when running `singularity help *` can be made by editing `docs/content.go`. diff --git a/INSTALL.md b/INSTALL.md index 27ec7aabfe..b739f19d7a 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -8,7 +8,7 @@ always be up-to-date with the latest source release version. For full instructions on installation, including building RPMs, installing pre-built EPEL packages etc. please check the -[installation section of the admin guide](https://singularity.hpcng.org/admin-docs/master/installation.html). +[installation section of the admin guide](https://apptainer.org/admin-docs/master/installation.html). ## Install system dependencies @@ -78,16 +78,16 @@ Golang is a bit finicky about where things are placed. Here is the correct way to build Singularity from source: ``` -$ mkdir -p ${GOPATH}/src/github.com/hpcng && \ - cd ${GOPATH}/src/github.com/hpcng && \ - git clone https://github.com/hpcng/singularity.git && \ +$ mkdir -p ${GOPATH}/src/github.com/apptainer && \ + cd ${GOPATH}/src/github.com/apptainer && \ + git clone https://github.com/apptainer/singularity.git && \ cd singularity ``` -To build a stable version of Singularity, check out a [release tag](https://github.com/hpcng/singularity/tags) before compiling: +To build a stable version of Singularity, check out a [release tag](https://github.com/apptainer/singularity/tags) before compiling: ``` -$ git checkout v3.8.5 +$ git checkout v3.8.6 ``` ## Compiling Singularity @@ -95,7 +95,7 @@ $ git checkout v3.8.5 You can build Singularity using the following commands: ``` -$ cd ${GOPATH}/src/github.com/hpcng/singularity && \ +$ cd ${GOPATH}/src/github.com/apptainer/singularity && \ ./mconfig && \ cd ./builddir && \ make && \ @@ -147,7 +147,7 @@ Download the latest and use it to install the RPM like this: ``` -$ export VERSION=3.8.5 # this is the singularity version, change as you need +$ export VERSION=3.8.6 # this is the singularity version, change as you need $ wget https://github.com/apptainer/singularity/releases/download/v${VERSION}/singularity-${VERSION}.tar.gz && \ rpmbuild -tb singularity-${VERSION}.tar.gz && \ @@ -161,7 +161,7 @@ for example like this if you already have a new enough golang first in your PATH: ``` -VERSION=3.8.5 # this is the singularity version, change as you need +VERSION=3.8.6 # this is the singularity version, change as you need ./mconfig make -C builddir rpm sudo rpm -ivh ~/rpmbuild/RPMS/x86_64/singularity-${VERSION}*.x86_64.rpm @@ -175,7 +175,7 @@ tarball and use it to install Singularity: $ cd $GOPATH/src/github.com/apptainer/singularity && \ ./mconfig && \ make -C builddir rpm && \ - sudo rpm -ivh ~/rpmbuild/RPMS/x86_64/singularity-3.8.5*.x86_64.rpm # or whatever version you built + sudo rpm -ivh ~/rpmbuild/RPMS/x86_64/singularity-3.8.6*.x86_64.rpm # or whatever version you built ``` To build an rpm with an alternative install prefix set RPMPREFIX on the diff --git a/README.md b/README.md index b35286631a..d180ed59b5 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Singularity -[![CI](https://github.com/hpcng/singularity/actions/workflows/ci.yml/badge.svg)](https://github.com/hpcng/singularity/actions/workflows/ci.yml) +[![CI](https://github.com/apptainer/singularity/actions/workflows/ci.yml/badge.svg)](https://github.com/apptainer/singularity/actions/workflows/ci.yml) - [Guidelines for Contributing](CONTRIBUTING.md) - [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md) - [Project License](LICENSE.md) -- [Documentation](https://singularity.hpcng.org/docs/) +- [Documentation](https://apptainer.org/docs/) - [Community Meetings / Minutes / Roadmap](https://drive.google.com/drive/u/0/folders/1npfBhIDxqeJIUHZ0tMeuHPvc_iB4T2B6) - [Support](#support) - [Citation](#citing-singularity) @@ -15,8 +15,8 @@ and secure. Singularity is optimized for compute focused enterprise and HPC workloads, allowing untrusted users to run untrusted containers in a trusted way. -Check out [talks about Singularity](https://singularity.hpcng.org/talks) -and some [use cases of Singularity](https://singularity.hpcng.org/usecases) +Check out [talks about Singularity](https://apptainer.org/talks) +and some [use cases of Singularity](https://apptainer.org/usecases) on our website. @@ -24,14 +24,14 @@ on our website. To install Singularity from source, see the [installation instructions](INSTALL.md). For other installation options, see [our -guide](https://singularity.hpcng.org/admin-docs/master/installation.html). +guide](https://apptainer.org/admin-docs/master/installation.html). System administrators can learn how to configure Singularity, and get an overview of its architecture and security features in the [administrator -guide](https://singularity.hpcng.org/admin-docs/master/). +guide](https://apptainer.org/admin-docs/master/). For users, see the [user -guide](https://singularity.hpcng.org/user-docs/master/) for details on how to use +guide](https://apptainer.org/user-docs/master/) for details on how to use and build Singularity containers. ## Contributing to Singularity @@ -40,16 +40,16 @@ Community contributions are always greatly appreciated. To start developing Singularity, check out the [guidelines for contributing](CONTRIBUTING.md). Our roadmap, other documents, and user/developer meeting information can be -found in the [singularity community page](https://singularity.hpcng.org/help). +found in the [singularity community page](https://apptainer.org/help). We also welcome contributions to our [user -guide](https://github.com/hpcng/singularity-userdocs) and [admin -guide](https://github.com/hpcng/singularity-admindocs). +guide](https://github.com/apptainer/singularity-userdocs) and [admin +guide](https://github.com/apptainer/singularity-admindocs). ## Support To get help with Singularity, check out the [Singularity -Help](https://singularity.hpcng.org/help) web page. +Help](https://apptainer.org/help) web page. ## Go Version Compatibility diff --git a/SUPPORT.md b/SUPPORT.md index 93eaa3d355..8f864193ea 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -3,14 +3,14 @@ Need help? We have several ways to reach us, depending on your preferences and needs. ## Documentation -If you haven't already, read our [documentation](https://singularity.hpcng.org/docs/). These docs have common use cases, and might be helpful to browse before submitting an issue. You can contribute to our documentation by creating PRs against the [singularity-admindocs](https://github.com/hpcng/singularity-admindocs) and [singularity-userdocs](https://github.com/hpcng/singularity-userdocs) repositories. +If you haven't already, read our [documentation](https://apptainer.org/docs/). These docs have common use cases, and might be helpful to browse before submitting an issue. You can contribute to our documentation by creating PRs against the [singularity-admindocs](https://github.com/apptainer/singularity-admindocs) and [singularity-userdocs](https://github.com/apptainer/singularity-userdocs) repositories. ## Github For issues with code (and especially if you need to share debug output) we recommend Github issues boards. - - [Singularity Issues](https://github.com/hpcng/singularity/issues): is recommended for most issues with the Singularity software. - - [User Documentation](https://github.com/hpcng/singularity-userdocs/issues) questions, feedback, and suggestions should go here. Feel free to create an issue on a board and additionally request updated content here. - - [Admin Documentation](https://github.com/hpcng/singularity-admindocs/issues) questions, feedback, and suggestions should go here. Feel free to create an issue on a board and additionally request updated content here. + - [Singularity Issues](https://github.com/apptainer/singularity/issues): is recommended for most issues with the Singularity software. + - [User Documentation](https://github.com/apptainer/singularity-userdocs/issues) questions, feedback, and suggestions should go here. Feel free to create an issue on a board and additionally request updated content here. + - [Admin Documentation](https://github.com/apptainer/singularity-admindocs/issues) questions, feedback, and suggestions should go here. Feel free to create an issue on a board and additionally request updated content here. ### How do I ask for help? @@ -38,6 +38,6 @@ Issues can go stale for a number of reasons. In the bullets below, we will revie You can reach the community quickly by way of joining our [Google Group](https://groups.google.com/a/lbl.gov/forum/#!forum/singularity). ## Slack -For real time support from the community, you can join our community on slack at [https://hpcng.slack.com/](https://hpcng.slack.com/). Ping the Google Group or one of the admins here to request to be added. +For real time support from the community, you can join our community on slack at [https://apptainer.slack.com/](https://apptainer.slack.com/). Ping the Google Group or one of the admins here to request to be added. -Is there something missing here you'd like to see? Please [let us know](https://github.com/hpcng/singularity/issues). +Is there something missing here you'd like to see? Please [let us know](https://github.com/apptainer/singularity/issues).