Skip to content

Commit

Permalink
docs: add upgrading doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ilunglee committed Nov 9, 2021
1 parent 879306d commit 0716642
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 8 deletions.
10 changes: 4 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,18 +107,16 @@ Adminterface hosts release candidate builds on Github packages. If you wish to t
```

### Upgrading
1. Replace the version of `adminterface` inside `Gemfile`
1. Replace `$VERSION` with the target RC version.
```ruby
source "https://rubygems.pkg.github.com/cmdbrew" do
# Replace [VERSION] with the target RC version
gem "adminterface", [VERSION]
gem "adminterface", "$VERSION"
end
```
2. Run `bundle install`
3. Replace the version of `adminterface` inside `package.json`
3. Replace `$VERSION` with the target RC version, and run:
```bash
# Replace [VERSION] with the target RC version
yarn upgrade @cmdbrew/adminterface@[VERSION]
yarn upgrade @cmdbrew/adminterface@$VERSION
```

## Releasing (maintainers only)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/start/cli.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 3
description: Adminterface Command Line Reference.
---

Expand Down
2 changes: 1 addition & 1 deletion website/docs/start/dependencies.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 99
sidebar_position: 98
description: Adminterface Dependencies and Licenses.
---

Expand Down
23 changes: 23 additions & 0 deletions website/docs/start/upgrading.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_position: 2
description: Adminterface Upgrading Guide.
---

# Upgrading
We kept the NPM package and the Ruby gem versions in sync. When upgrading, please ensure you update them both.

## Update the Gem
Replace `$VERSION` with the target version.
```ruby title="Gemfile"
gem "adminterface", "$VERSION"
```
And, run:
```bash
bundle install
```

## Update the NPM package
Replace `$VERSION` with the target version, and run:
```bash
yarn upgrade @cmdbrew/adminterface@$VERSION
```

0 comments on commit 0716642

Please sign in to comment.