Skip to content

Commit

Permalink
Merge pull request apptainer#6014 from DrDaveD/fix-mdfiles
Browse files Browse the repository at this point in the history
Update web page links in md files
  • Loading branch information
ikaneshiro authored Jun 8, 2021
2 parents a4ca82b + d1f2ab5 commit 48f3d0a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ 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://www.sylabs.io/guides/latest/user-guide/) and [admin-docs](https://www.sylabs.io/guides/latest/admin-guide/) 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://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.

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.
Expand Down
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,31 @@
- [Guidelines for Contributing](CONTRIBUTING.md)
- [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md)
- [Project License](LICENSE.md)
- [Documentation](https://www.sylabs.io/docs/)
- [Documentation](https://singularity.hpcng.org/docs/)
- [Citation](#citing-singularity)

Singularity is an open source container platform designed to be simple, fast,
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://www.sylabs.io/videos) and some [use
cases of Singularity](https://sylabs.io/case-studies) on our website.
Check out [talks about Singularity](https://singularity.hpcng.org/videos)
and some [use cases of Singularity](https://singularity.hpcng.org/usecases)
on our website.


## Getting Started with Singularity

To install Singularity from source, see the [installation
instructions](INSTALL.md). For other installation options, see [our
guide](https://www.sylabs.io/guides/latest/admin-guide/).
guide](https://singularity.hpcng.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://www.sylabs.io/guides/latest/admin-guide/).
guide](https://singularity.hpcng.org/admin-docs/master/).

For users, see the [user
guide](https://www.sylabs.io/guides/latest/user-guide/) for details on how to use
guide](https://singularity.hpcng.org/user-docs/master/) for details on how to use
and build Singularity containers.

## Contributing to Singularity
Expand All @@ -42,11 +43,8 @@ guide](https://github.com/hpcng/singularity-admindocs).

## Support

To get help with Singularity, check out the [Community
Portal](https://www.sylabs.io/singularity/community/).

For additional support, [contact us](https://www.sylabs.io/contact/) to receive
more information.
To get help with Singularity, check out the [Singularity
Help](https://singularity.hpcng.org/help) web page.

## Citing Singularity

Expand Down

0 comments on commit 48f3d0a

Please sign in to comment.