Skip to content

Commit

Permalink
Write 2.0.0 upgrade notes enonic#674
Browse files Browse the repository at this point in the history
  • Loading branch information
pmi committed Sep 12, 2023
1 parent 0caafc1 commit ca13576
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/menu.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,16 @@
{
"title": "TL;DR",
"document": "tldr"
},
{
"title": "Release Notes",
"document": "release",
"menuItems": [
{
"title": "Upgrade Notes",
"document": "release/upgrade"
}
]
}
]
}
2 changes: 2 additions & 0 deletions docs/release.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
= Release Notes
:toc: right
39 changes: 39 additions & 0 deletions docs/release/upgrade.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
= Upgrading
:toc: right

== Guillotine application

IMPORTANT: Guillotine version 7 is required if you need to modify graphql schema in your application.

== Upgrading from v1.x

1. Update env vars to:

APP_NAME -> ENONIC_APP_NAME
CONTENT_API -> ENONIC_API
API_TOKEN -> ENONIC_API_TOKEN
remove SITE_KEY
add ENONIC_PROJECTS=<repo-name>/site/path[,<lang>:<repo-name>/site/path,...]

2. Add i18n config block to next.config.js

i18n: {
locales: ['en', 'no'],
defaultLocale: 'en',
}

3. Remove lib-nextxp dependency from your enonic xp app build.gradle file
4. Install app-nextxp enonic app
5. Add config file `_com.enonic.app.nextxp.cfg_` with following content:

# uncomment this to override defaults
# nextjs.default.secret=yourSecret
# nextjs.default.url=https://new.enonic.com
# named configs
nextjs.<config-name>.secret=yourSecret
nextjs.<config-name>.url=https://your.next-site.com

6. Add app nextxp to your site and save it

7. Default configuration will be used automatically for the entire site.
You can change it by going to app-nextxp config and selecting any of the previously defined named configurations.
5 changes: 5 additions & 0 deletions docs/versions.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
{
"versions": [
{
"label": "1.x",
"checkout": "662bd08f69be6011aa69d0d962a94621eebe69c0",
"latest": false
},
{
"label": "stable",
"checkout": "master",
Expand Down

0 comments on commit ca13576

Please sign in to comment.