Skip to content

Commit e6433fa

Browse files
authored
Merge pull request #6376 from DrDaveD/remove-hpcng
Remove hpcng from md files, update INSTALL.md for 3.8.6
2 parents c63407c + 5bc4140 commit e6433fa

File tree

4 files changed

+30
-30
lines changed

4 files changed

+30
-30
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ all your interactions with the project members and users.
6363
additions to `go.mod` should explain why the dependency is required.
6464

6565
## Documentation
66-
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.
66+
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.
6767

6868
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.
6969
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.
70-
3. The [user-docs](https://www.github.com/hpcng/singularity-userdocs) should document anything pertinent to the usage of Singularity.
71-
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.
70+
3. The [user-docs](https://www.github.com/apptainer/singularity-userdocs) should document anything pertinent to the usage of Singularity.
71+
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.
7272
5. If necessary, changes to the message displayed when running `singularity help *` can be made by editing `docs/content.go`.
7373

7474

INSTALL.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ always be up-to-date with the latest source release version.
88

99
For full instructions on installation, including building RPMs,
1010
installing pre-built EPEL packages etc. please check the
11-
[installation section of the admin guide](https://singularity.hpcng.org/admin-docs/master/installation.html).
11+
[installation section of the admin guide](https://apptainer.org/admin-docs/master/installation.html).
1212

1313
## Install system dependencies
1414

@@ -78,24 +78,24 @@ Golang is a bit finicky about where things are placed. Here is the correct way
7878
to build Singularity from source:
7979

8080
```
81-
$ mkdir -p ${GOPATH}/src/github.com/hpcng && \
82-
cd ${GOPATH}/src/github.com/hpcng && \
83-
git clone https://github.com/hpcng/singularity.git && \
81+
$ mkdir -p ${GOPATH}/src/github.com/apptainer && \
82+
cd ${GOPATH}/src/github.com/apptainer && \
83+
git clone https://github.com/apptainer/singularity.git && \
8484
cd singularity
8585
```
8686

87-
To build a stable version of Singularity, check out a [release tag](https://github.com/hpcng/singularity/tags) before compiling:
87+
To build a stable version of Singularity, check out a [release tag](https://github.com/apptainer/singularity/tags) before compiling:
8888

8989
```
90-
$ git checkout v3.8.5
90+
$ git checkout v3.8.6
9191
```
9292

9393
## Compiling Singularity
9494

9595
You can build Singularity using the following commands:
9696

9797
```
98-
$ cd ${GOPATH}/src/github.com/hpcng/singularity && \
98+
$ cd ${GOPATH}/src/github.com/apptainer/singularity && \
9999
./mconfig && \
100100
cd ./builddir && \
101101
make && \
@@ -147,7 +147,7 @@ Download the latest
147147
and use it to install the RPM like this:
148148

149149
```
150-
$ export VERSION=3.8.5 # this is the singularity version, change as you need
150+
$ export VERSION=3.8.6 # this is the singularity version, change as you need
151151
152152
$ wget https://github.com/apptainer/singularity/releases/download/v${VERSION}/singularity-${VERSION}.tar.gz && \
153153
rpmbuild -tb singularity-${VERSION}.tar.gz && \
@@ -161,7 +161,7 @@ for example like this if you already have a new enough golang first
161161
in your PATH:
162162
163163
```
164-
VERSION=3.8.5 # this is the singularity version, change as you need
164+
VERSION=3.8.6 # this is the singularity version, change as you need
165165
./mconfig
166166
make -C builddir rpm
167167
sudo rpm -ivh ~/rpmbuild/RPMS/x86_64/singularity-${VERSION}*.x86_64.rpm
@@ -175,7 +175,7 @@ tarball and use it to install Singularity:
175175
$ cd $GOPATH/src/github.com/apptainer/singularity && \
176176
./mconfig && \
177177
make -C builddir rpm && \
178-
sudo rpm -ivh ~/rpmbuild/RPMS/x86_64/singularity-3.8.5*.x86_64.rpm # or whatever version you built
178+
sudo rpm -ivh ~/rpmbuild/RPMS/x86_64/singularity-3.8.6*.x86_64.rpm # or whatever version you built
179179
```
180180
181181
To build an rpm with an alternative install prefix set RPMPREFIX on the

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Singularity
22

3-
[![CI](https://github.com/hpcng/singularity/actions/workflows/ci.yml/badge.svg)](https://github.com/hpcng/singularity/actions/workflows/ci.yml)
3+
[![CI](https://github.com/apptainer/singularity/actions/workflows/ci.yml/badge.svg)](https://github.com/apptainer/singularity/actions/workflows/ci.yml)
44

55
- [Guidelines for Contributing](CONTRIBUTING.md)
66
- [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md)
77
- [Project License](LICENSE.md)
8-
- [Documentation](https://singularity.hpcng.org/docs/)
8+
- [Documentation](https://apptainer.org/docs/)
99
- [Community Meetings / Minutes / Roadmap](https://drive.google.com/drive/u/0/folders/1npfBhIDxqeJIUHZ0tMeuHPvc_iB4T2B6)
1010
- [Support](#support)
1111
- [Citation](#citing-singularity)
@@ -15,23 +15,23 @@ and secure. Singularity is optimized for compute focused enterprise and HPC
1515
workloads, allowing untrusted users to run untrusted containers in a trusted
1616
way.
1717

18-
Check out [talks about Singularity](https://singularity.hpcng.org/talks)
19-
and some [use cases of Singularity](https://singularity.hpcng.org/usecases)
18+
Check out [talks about Singularity](https://apptainer.org/talks)
19+
and some [use cases of Singularity](https://apptainer.org/usecases)
2020
on our website.
2121

2222

2323
## Getting Started with Singularity
2424

2525
To install Singularity from source, see the [installation
2626
instructions](INSTALL.md). For other installation options, see [our
27-
guide](https://singularity.hpcng.org/admin-docs/master/installation.html).
27+
guide](https://apptainer.org/admin-docs/master/installation.html).
2828

2929
System administrators can learn how to configure Singularity, and get an
3030
overview of its architecture and security features in the [administrator
31-
guide](https://singularity.hpcng.org/admin-docs/master/).
31+
guide](https://apptainer.org/admin-docs/master/).
3232

3333
For users, see the [user
34-
guide](https://singularity.hpcng.org/user-docs/master/) for details on how to use
34+
guide](https://apptainer.org/user-docs/master/) for details on how to use
3535
and build Singularity containers.
3636

3737
## Contributing to Singularity
@@ -40,16 +40,16 @@ Community contributions are always greatly appreciated. To start developing
4040
Singularity, check out the [guidelines for contributing](CONTRIBUTING.md).
4141

4242
Our roadmap, other documents, and user/developer meeting information can be
43-
found in the [singularity community page](https://singularity.hpcng.org/help).
43+
found in the [singularity community page](https://apptainer.org/help).
4444

4545
We also welcome contributions to our [user
46-
guide](https://github.com/hpcng/singularity-userdocs) and [admin
47-
guide](https://github.com/hpcng/singularity-admindocs).
46+
guide](https://github.com/apptainer/singularity-userdocs) and [admin
47+
guide](https://github.com/apptainer/singularity-admindocs).
4848

4949
## Support
5050

5151
To get help with Singularity, check out the [Singularity
52-
Help](https://singularity.hpcng.org/help) web page.
52+
Help](https://apptainer.org/help) web page.
5353

5454
## Go Version Compatibility
5555

SUPPORT.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
Need help? We have several ways to reach us, depending on your preferences and needs.
44

55
## Documentation
6-
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.
6+
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.
77

88
## Github
99
For issues with code (and especially if you need to share debug output) we recommend Github issues boards.
1010

11-
- [Singularity Issues](https://github.com/hpcng/singularity/issues): is recommended for most issues with the Singularity software.
12-
- [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.
13-
- [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.
11+
- [Singularity Issues](https://github.com/apptainer/singularity/issues): is recommended for most issues with the Singularity software.
12+
- [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.
13+
- [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.
1414

1515

1616
### 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
3838
You can reach the community quickly by way of joining our [Google Group](https://groups.google.com/a/lbl.gov/forum/#!forum/singularity).
3939

4040
## Slack
41-
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.
41+
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.
4242

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

0 commit comments

Comments
 (0)