Skip to content

Commit

Permalink
Merge pull request #2207 from bauerm97/changelog
Browse files Browse the repository at this point in the history
Last minute changes to changelog and link fixes
  • Loading branch information
yhcote authored Oct 8, 2018
2 parents 0210b1f + 0b5d865 commit b585863
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 12 deletions.
9 changes: 5 additions & 4 deletions .github/RELEASE_PROCEDURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,18 @@ _This file uses `v3.0.0` as an example release_

## Documentation
Ensure that our documentation is up to date:
- [User Docs](https://www.sylabs.io/guides/latest/user-guide/) can be edited [here](https://github.com/sylabs/singularity-userdocs)
- [Admin Docs](https://www.sylabs.io/guides/latest/admin-guide/) can be edited [here](https://github.com/sylabs/singularity-admindocs)
- [User Docs](https://www.sylabs.io/guides/3.0/user-guide/) can be edited [here](https://github.com/sylabs/singularity-userdocs)
- [Admin Docs](https://www.sylabs.io/guides/3.0/admin-guide/) can be edited [here](https://github.com/sylabs/singularity-admindocs)


## Announcements
Release announcements should be made on:
- GitHub [releases page](https://github.com/sylabs/singularity/releases)
- Run `make -C builddir/ dist` and attach the generated tarball as an asset to the release
- **NOTE:** The GitHub release MUST contain a line about the proper installation procedure when installing from the GitHub generated tarballs. Namely, that you must build using `./mconfig [-V version]`
- Singularity mailing list
- Singularity [Slack channel](https://www.sylabs.io/community/)
- Blog post on [sylabs.io](https://www.sylabs.io/lab-notes/)
- Singularity [Slack channel](https://www.sylabs.io/join-the-community/)
- Blog post on [sylabs.io](https://www.sylabs.io/category/labnotes/)
- Various twitter channels:
- [@SylabsIO](https://twitter.com/sylabsio)
- [@SingularityApp](https://twitter.com/singularityapp)
Expand Down
7 changes: 5 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ _With the release of `v3.0.0`, we're introducing a new changelog format in an at

_The old changelog can be found in the `release-2.6` branch_

# Changes Since v2.6.0
# Changes Since v3.0.0

# v3.0.0 - [2018.10.08]

- Singularity is now written primarily in Go to bring better integration with the existing container ecosystem
- Added support for new URIs (`build` & `run/exec/shell/start`):
Expand Down Expand Up @@ -78,4 +80,5 @@ _The old changelog can be found in the `release-2.6` branch_
- `oci`
- `oci-archive`
- The `from` keyword in the definition file now correctly parses a `docker` URI which includes the `registry` and/or `namespace` components
- The `registry` and `namespace` keywords in the definition file are no longer supported. Instead, those values may all go into the `from` keyword
- The `registry` and `namespace` keywords in the definition file are no longer supported. Instead, those values may all go into the `from` keyword
- Building from a tar archive of a `sandbox` no longer works
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ all your interactions with the project members and users.
12. PRs which introduce a new Golang dependency to the project via `dep` must include a justification for introducing the dependency. Ideally, newly introduced dependencies should also be pinned to a specific version.

## 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://www.sylabs.io/guides/3.0/user-guide/) and [admin-docs](https://www.sylabs.io/guides/3.0/admin-guide/) 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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@

Singularity is an open source container platform designed to be simple, fast, and secure. Singularity is optimized for EPC and HPC workloads, allowing untrusted users to run untrusted containers in a trusted way.

Check out [who is using Singularity](https://www.sylabs.io/as-seen-on/) and some [use cases of Singularity](https://www.sylabs.io/category/how-tos/) on our website.
Check out [who is using Singularity](https://www.sylabs.io/singularity/whos-using-singularity/) and some [use cases of Singularity](https://www.sylabs.io/category/how-tos/) on our website.

## Getting Started with Singularity

To install Singularity from source, see the [installation instructions](INSTALL.md). For other installation options, see [our website](https://www.sylabs.io/singularity-pro/).
To install Singularity from source, see the [installation instructions](INSTALL.md). For other installation options, see [our website](https://www.sylabs.io/singularity/download/).

For system administrators, see the [administrator documentation](https://www.sylabs.io/guides/latest/admin-guide/).
For system administrators, see the [administrator documentation](https://www.sylabs.io/guides/3.0/admin-guide/).

For users, see the [user documentation](https://www.sylabs.io/guides/latest/user-guide/).
For users, see the [user documentation](https://www.sylabs.io/guides/3.0/user-guide/).

## Contributing to Singularity

Expand All @@ -30,7 +30,7 @@ We also welcome contributions to our [user docs](https://github.com/sylabs/singu

## Support

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

For additional support, [contact us](https://www.sylabs.io/contact/) to receive more information.

Expand Down

0 comments on commit b585863

Please sign in to comment.