[DOCS] 6.0.0 Release (#2888)

* docs: added docs for 6.0.0 release * fix: restored url docs
2026-08-11 11:27:10 +08:00 · 2020-03-17 17:12:50 +00:00
parent 331a83d1fc
commit 6ba7a43cb4
100 changed files with 45 additions and 13 deletions
@@ -78,7 +78,7 @@ sidebar:
    - title: Docker
      url: https://hub.docker.com/r/coralproject/talk/
  side:
-    - title: Version 5
+    - title: Version 5+
      children:
        - title: Getting started
          children:
@@ -222,6 +222,8 @@ sidebar:
              url: /migration/4.1/
            - title: Migrating to v5.0.0
              url: /migration/5.0/
+            - title: Migrating to v6.0.0
+              url: /migration/6.0/
    - title: FAQ & Troubleshooting
      children:
        - children:
@@ -30,7 +30,7 @@ Try a test version of Coral by running it via a Heroku App:
 You can install Coral using Docker or via Source. We recommend Docker, as it
 provides the easiest deployment solution going forward, as all the dependencies
 are baked and shipped with the provided
-[coralproject/talk:5](https://hub.docker.com/r/coralproject/talk) image.
+[coralproject/talk:6](https://hub.docker.com/r/coralproject/talk) image.

 ### Docker

@@ -50,7 +50,7 @@ cat > docker-compose.yml <<EOF
 version: "2"
 services:
  talk:
-    image: coralproject/talk:5
+    image: coralproject/talk:6
    restart: always
    ports:
      - "127.0.0.1:3000:5000"
@@ -45,6 +45,10 @@ You will then have to generate a JWT with the following claims:
  a user's subscription status.
 - `user.role` _(optional)_ - one of "COMMENTER", "STAFF", "MODERATOR", "ADMIN". Will create/update
  Coral user with this role.
+- `user.url` _(optional)_ - url for user account management, where a user will
+  be able to perform account management tasks such as changing password or
+  deleting data. If provided, user will be able to access this URL by clicking
+  on the "account" tab from the stream.

 An example of the claims for this token would be:

@@ -7,26 +7,32 @@ permalink: /migration/5.0/

 **Trying will break your install of Coral!**

-Coral version 5.0.0 is more than just a version bump, it includes a fundamental rewrite of underlying core components, changes to the database schema, and the introduction of Typescript strong data types. This means migrating is a bit more complicated than running a simple database migration. 
+Coral version 5.0.0 is more than just a version bump, it includes a fundamental rewrite of underlying core components, changes to the database schema, and the introduction of Typescript strong data types. This means migrating is a bit more complicated than running a simple database migration.

 ### Migration Path
-A step by step migration path is currently in development, and we will be announcing it here once it’s ready. 
+
+A step by step migration path is currently in development, and we will be announcing it here once it’s ready.

 The process for migration will include:
-* Create a mongodump export of your 4.x.x database
-* Use an import tool to transform the data for v5, and import it to a new mongo database
-* Deploy & configure v5 on your production infrastructure (pointing to new DB)
-* Update your embed script to the new version

-Downtime will be required to complete the migration, and you should carefully plan your migration accordingly depending on your infrastructure setup, and amount of data to be migrated. 
+- Create a mongodump export of your 4.x.x database
+- Use an import tool to transform the data for v5, and import it to a new mongo database
+- Deploy & configure v5 on your production infrastructure (pointing to new DB)
+- Update your embed script to the new version
+
+Downtime will be required to complete the migration, and you should carefully plan your migration accordingly depending on your infrastructure setup, and amount of data to be migrated.

 ### Migrating Plugins
-Plugins are no longer supported and will not work with any instance of Coral >= v5. Most of the optional `talk-plugin` features have been built right into core so you no longer need install, manage, and worry about plugins. If you were using plugins to achieve custom functionality, please contact us to learn about some of the new ways to solve custom use cases in v5 and beyond. 

+Plugins are no longer supported and will not work with any instance of Coral >= v5. Most of the optional `talk-plugin` features have been built right into core so you no longer need install, manage, and worry about plugins. If you were using plugins to achieve custom functionality, please contact us to learn about some of the new ways to solve custom use cases in v5 and beyond.

 ### Supporting your Migration
+
 We would love to help!

-If you’re currently running any open source version 4.x.x and would like assistance with planning and/or executing a migration please reach out to us at support@coralproject.net. 
+If you’re currently running any open source version 4.x/5.x and would like
+assistance with planning and/or executing a migration please reach out to us at
+support@coralproject.net.

-We can help you figure out the best path forward, and give you early access to the migration tools we’re working on. 
+We can help you figure out the best path forward, and give you early access to
+the migration tools we’re working on.
@@ -0,0 +1,20 @@
+---
+title: Migrating to v6
+permalink: /migration/6.0/
+---
+
+Coral 6.0.0 introduces new features to assist with large communities using
+Coral. To migrate from any 5.x.x release, ensure you first upgrade to 5.5.1
+and allow all migrations to run. This means that you cannot upgrade from any
+version below 5.5.1 to 6.0.0 directly.
+
+### Supporting your Migration
+
+We would love to help!
+
+If you’re currently running any open source version 4.x/5.x and would like
+assistance with planning and/or executing a migration please reach out to us at
+support@coralproject.net.
+
+We can help you figure out the best path forward, and give you early access to
+the migration tools we’re working on.