Skip to content

Commit

Permalink
Update wording
Browse files Browse the repository at this point in the history
  • Loading branch information
fatso83 authored and mroderick committed Mar 27, 2023
1 parent a3dd193 commit 2e486df
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 9 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@ Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com

<a href="https://opencollective.com/sinon#backers" target="_blank"><img src="https://opencollective.com/sinon/backers.svg?width=890"></a>


## Sponsors

Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/sinon#sponsor)]
Expand Down
12 changes: 4 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,17 @@ published: false

# Docs

This folder structure contains the markdown files that becomes the Sinon.JS documentation site published to GitHub Pages. Eventually this will replace the current site at https://sinonjs.org.
This folder structure contains the markdown files that is the Sinon.JS documentation site published to GitHub Pages.

See [CONTRIBUTING.md](CONTRIBUTING.md) for details on contributing documentation to Sinon.JS. This file also lists how to run the site locally.

## Documentation release process

Whenever a new release is created using `npm version`, the tree from `release-source/release/` is copied into its own folder under `releases/` with an appropriate name.

Whenever a new release is created using `npm version`, the tree from `release-source/release/` is copied into a folder under `releases/` with an appropriate name.
Likewise, the `_releases/release.md` file is copied into a file matching the release name.

### Example

Let's say that we're making a new `v2.0.3` release.
Currently, we keep a single folder per major release.

- `release-source/release/` is copied into a new folder `_releases/v2.0.3/`
- `release-source/release.md` is copied into a new file `_releases/v2.0.3.md`
See `scripts/postversion.sh` for details on the exact process, as it changes over time.

The release is packaged, tagged and pushed to GitHub. GitHub Pages will build a new site in a few minutes, and replace the old one.

0 comments on commit 2e486df

Please sign in to comment.