diff --git a/docs/_config.yml b/docs/_config.yml index eb89b4bdf..a38602ed1 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -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: diff --git a/docs/source/version-5-installation.md b/docs/source/01-01-installation.md similarity index 97% rename from docs/source/version-5-installation.md rename to docs/source/01-01-installation.md index d75ea2b62..b5386b5d8 100644 --- a/docs/source/version-5-installation.md +++ b/docs/source/01-01-installation.md @@ -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 <= 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. diff --git a/docs/source/legacy/06-05-migrating-6.md b/docs/source/legacy/06-05-migrating-6.md new file mode 100644 index 000000000..82164e900 --- /dev/null +++ b/docs/source/legacy/06-05-migrating-6.md @@ -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. diff --git a/docs/source/07-01-faq.md b/docs/source/legacy/07-01-faq.md similarity index 100% rename from docs/source/07-01-faq.md rename to docs/source/legacy/07-01-faq.md diff --git a/docs/source/07-02-troubleshooting-tips.md b/docs/source/legacy/07-02-troubleshooting-tips.md similarity index 100% rename from docs/source/07-02-troubleshooting-tips.md rename to docs/source/legacy/07-02-troubleshooting-tips.md diff --git a/docs/source/api/client.md b/docs/source/legacy/api/client.md similarity index 100% rename from docs/source/api/client.md rename to docs/source/legacy/api/client.md diff --git a/docs/source/api/graphql.md b/docs/source/legacy/api/graphql.md similarity index 100% rename from docs/source/api/graphql.md rename to docs/source/legacy/api/graphql.md diff --git a/docs/source/api/overview.md b/docs/source/legacy/api/overview.md similarity index 100% rename from docs/source/api/overview.md rename to docs/source/legacy/api/overview.md diff --git a/docs/source/api/server.md b/docs/source/legacy/api/server.md similarity index 100% rename from docs/source/api/server.md rename to docs/source/legacy/api/server.md diff --git a/docs/source/api/slots.md b/docs/source/legacy/api/slots.md similarity index 100% rename from docs/source/api/slots.md rename to docs/source/legacy/api/slots.md diff --git a/docs/source/integrating/amp.md b/docs/source/legacy/integrating/amp.md similarity index 100% rename from docs/source/integrating/amp.md rename to docs/source/legacy/integrating/amp.md diff --git a/docs/source/integrating/asset-scraping.md b/docs/source/legacy/integrating/asset-scraping.md similarity index 100% rename from docs/source/integrating/asset-scraping.md rename to docs/source/legacy/integrating/asset-scraping.md diff --git a/docs/source/integrating/authentication.md b/docs/source/legacy/integrating/authentication.md similarity index 100% rename from docs/source/integrating/authentication.md rename to docs/source/legacy/integrating/authentication.md diff --git a/docs/source/integrating/cms-integration.md b/docs/source/legacy/integrating/cms-integration.md similarity index 100% rename from docs/source/integrating/cms-integration.md rename to docs/source/legacy/integrating/cms-integration.md diff --git a/docs/source/integrating/configuring-admin.md b/docs/source/legacy/integrating/configuring-admin.md similarity index 100% rename from docs/source/integrating/configuring-admin.md rename to docs/source/legacy/integrating/configuring-admin.md diff --git a/docs/source/integrating/configuring-comment-stream.md b/docs/source/legacy/integrating/configuring-comment-stream.md similarity index 100% rename from docs/source/integrating/configuring-comment-stream.md rename to docs/source/legacy/integrating/configuring-comment-stream.md diff --git a/docs/source/integrating/event-tracking-metrics.md b/docs/source/legacy/integrating/event-tracking-metrics.md similarity index 100% rename from docs/source/integrating/event-tracking-metrics.md rename to docs/source/legacy/integrating/event-tracking-metrics.md diff --git a/docs/source/integrating/notifications.md b/docs/source/legacy/integrating/notifications.md similarity index 100% rename from docs/source/integrating/notifications.md rename to docs/source/legacy/integrating/notifications.md diff --git a/docs/source/integrating/styling-css.md b/docs/source/legacy/integrating/styling-css.md similarity index 100% rename from docs/source/integrating/styling-css.md rename to docs/source/legacy/integrating/styling-css.md diff --git a/docs/source/integrating/translations-i18n.md b/docs/source/legacy/integrating/translations-i18n.md similarity index 100% rename from docs/source/integrating/translations-i18n.md rename to docs/source/legacy/integrating/translations-i18n.md diff --git a/docs/source/plugin/talk-plugin-akismet.md b/docs/source/legacy/plugin/talk-plugin-akismet.md similarity index 100% rename from docs/source/plugin/talk-plugin-akismet.md rename to docs/source/legacy/plugin/talk-plugin-akismet.md diff --git a/docs/source/plugin/talk-plugin-auth.md b/docs/source/legacy/plugin/talk-plugin-auth.md similarity index 100% rename from docs/source/plugin/talk-plugin-auth.md rename to docs/source/legacy/plugin/talk-plugin-auth.md diff --git a/docs/source/plugin/talk-plugin-author-menu.md b/docs/source/legacy/plugin/talk-plugin-author-menu.md similarity index 100% rename from docs/source/plugin/talk-plugin-author-menu.md rename to docs/source/legacy/plugin/talk-plugin-author-menu.md diff --git a/docs/source/plugin/talk-plugin-comment-content.md b/docs/source/legacy/plugin/talk-plugin-comment-content.md similarity index 100% rename from docs/source/plugin/talk-plugin-comment-content.md rename to docs/source/legacy/plugin/talk-plugin-comment-content.md diff --git a/docs/source/plugin/talk-plugin-deep-reply-count.md b/docs/source/legacy/plugin/talk-plugin-deep-reply-count.md similarity index 100% rename from docs/source/plugin/talk-plugin-deep-reply-count.md rename to docs/source/legacy/plugin/talk-plugin-deep-reply-count.md diff --git a/docs/source/plugin/talk-plugin-facebook-auth.md b/docs/source/legacy/plugin/talk-plugin-facebook-auth.md similarity index 100% rename from docs/source/plugin/talk-plugin-facebook-auth.md rename to docs/source/legacy/plugin/talk-plugin-facebook-auth.md diff --git a/docs/source/plugin/talk-plugin-featured-comments.md b/docs/source/legacy/plugin/talk-plugin-featured-comments.md similarity index 100% rename from docs/source/plugin/talk-plugin-featured-comments.md rename to docs/source/legacy/plugin/talk-plugin-featured-comments.md diff --git a/docs/source/plugin/talk-plugin-flag-details.md b/docs/source/legacy/plugin/talk-plugin-flag-details.md similarity index 100% rename from docs/source/plugin/talk-plugin-flag-details.md rename to docs/source/legacy/plugin/talk-plugin-flag-details.md diff --git a/docs/source/plugin/talk-plugin-google-auth.md b/docs/source/legacy/plugin/talk-plugin-google-auth.md similarity index 100% rename from docs/source/plugin/talk-plugin-google-auth.md rename to docs/source/legacy/plugin/talk-plugin-google-auth.md diff --git a/docs/source/plugin/talk-plugin-ignore-user.md b/docs/source/legacy/plugin/talk-plugin-ignore-user.md similarity index 100% rename from docs/source/plugin/talk-plugin-ignore-user.md rename to docs/source/legacy/plugin/talk-plugin-ignore-user.md diff --git a/docs/source/plugin/talk-plugin-like.md b/docs/source/legacy/plugin/talk-plugin-like.md similarity index 100% rename from docs/source/plugin/talk-plugin-like.md rename to docs/source/legacy/plugin/talk-plugin-like.md diff --git a/docs/source/plugin/talk-plugin-local-auth.md b/docs/source/legacy/plugin/talk-plugin-local-auth.md similarity index 100% rename from docs/source/plugin/talk-plugin-local-auth.md rename to docs/source/legacy/plugin/talk-plugin-local-auth.md diff --git a/docs/source/plugin/talk-plugin-love.md b/docs/source/legacy/plugin/talk-plugin-love.md similarity index 100% rename from docs/source/plugin/talk-plugin-love.md rename to docs/source/legacy/plugin/talk-plugin-love.md diff --git a/docs/source/plugin/talk-plugin-member-since.md b/docs/source/legacy/plugin/talk-plugin-member-since.md similarity index 100% rename from docs/source/plugin/talk-plugin-member-since.md rename to docs/source/legacy/plugin/talk-plugin-member-since.md diff --git a/docs/source/plugin/talk-plugin-moderation-actions.md b/docs/source/legacy/plugin/talk-plugin-moderation-actions.md similarity index 100% rename from docs/source/plugin/talk-plugin-moderation-actions.md rename to docs/source/legacy/plugin/talk-plugin-moderation-actions.md diff --git a/docs/source/plugin/talk-plugin-notifications-category-featured.md b/docs/source/legacy/plugin/talk-plugin-notifications-category-featured.md similarity index 100% rename from docs/source/plugin/talk-plugin-notifications-category-featured.md rename to docs/source/legacy/plugin/talk-plugin-notifications-category-featured.md diff --git a/docs/source/plugin/talk-plugin-notifications-category-moderation-actions.md b/docs/source/legacy/plugin/talk-plugin-notifications-category-moderation-actions.md similarity index 100% rename from docs/source/plugin/talk-plugin-notifications-category-moderation-actions.md rename to docs/source/legacy/plugin/talk-plugin-notifications-category-moderation-actions.md diff --git a/docs/source/plugin/talk-plugin-notifications-category-reply.md b/docs/source/legacy/plugin/talk-plugin-notifications-category-reply.md similarity index 100% rename from docs/source/plugin/talk-plugin-notifications-category-reply.md rename to docs/source/legacy/plugin/talk-plugin-notifications-category-reply.md diff --git a/docs/source/plugin/talk-plugin-notifications-category-staff.md b/docs/source/legacy/plugin/talk-plugin-notifications-category-staff.md similarity index 100% rename from docs/source/plugin/talk-plugin-notifications-category-staff.md rename to docs/source/legacy/plugin/talk-plugin-notifications-category-staff.md diff --git a/docs/source/plugin/talk-plugin-notifications-digest-daily.md b/docs/source/legacy/plugin/talk-plugin-notifications-digest-daily.md similarity index 100% rename from docs/source/plugin/talk-plugin-notifications-digest-daily.md rename to docs/source/legacy/plugin/talk-plugin-notifications-digest-daily.md diff --git a/docs/source/plugin/talk-plugin-notifications-digest-hourly.md b/docs/source/legacy/plugin/talk-plugin-notifications-digest-hourly.md similarity index 100% rename from docs/source/plugin/talk-plugin-notifications-digest-hourly.md rename to docs/source/legacy/plugin/talk-plugin-notifications-digest-hourly.md diff --git a/docs/source/plugin/talk-plugin-notifications.md b/docs/source/legacy/plugin/talk-plugin-notifications.md similarity index 100% rename from docs/source/plugin/talk-plugin-notifications.md rename to docs/source/legacy/plugin/talk-plugin-notifications.md diff --git a/docs/source/plugin/talk-plugin-offtopic.md b/docs/source/legacy/plugin/talk-plugin-offtopic.md similarity index 100% rename from docs/source/plugin/talk-plugin-offtopic.md rename to docs/source/legacy/plugin/talk-plugin-offtopic.md diff --git a/docs/source/plugin/talk-plugin-permalink.md b/docs/source/legacy/plugin/talk-plugin-permalink.md similarity index 100% rename from docs/source/plugin/talk-plugin-permalink.md rename to docs/source/legacy/plugin/talk-plugin-permalink.md diff --git a/docs/source/plugin/talk-plugin-profile-data.md b/docs/source/legacy/plugin/talk-plugin-profile-data.md similarity index 100% rename from docs/source/plugin/talk-plugin-profile-data.md rename to docs/source/legacy/plugin/talk-plugin-profile-data.md diff --git a/docs/source/plugin/talk-plugin-remember-sort.md b/docs/source/legacy/plugin/talk-plugin-remember-sort.md similarity index 100% rename from docs/source/plugin/talk-plugin-remember-sort.md rename to docs/source/legacy/plugin/talk-plugin-remember-sort.md diff --git a/docs/source/plugin/talk-plugin-respect.md b/docs/source/legacy/plugin/talk-plugin-respect.md similarity index 100% rename from docs/source/plugin/talk-plugin-respect.md rename to docs/source/legacy/plugin/talk-plugin-respect.md diff --git a/docs/source/plugin/talk-plugin-rich-text.md b/docs/source/legacy/plugin/talk-plugin-rich-text.md similarity index 100% rename from docs/source/plugin/talk-plugin-rich-text.md rename to docs/source/legacy/plugin/talk-plugin-rich-text.md diff --git a/docs/source/plugin/talk-plugin-slack-notifications.md b/docs/source/legacy/plugin/talk-plugin-slack-notifications.md similarity index 100% rename from docs/source/plugin/talk-plugin-slack-notifications.md rename to docs/source/legacy/plugin/talk-plugin-slack-notifications.md diff --git a/docs/source/plugin/talk-plugin-sort-most-liked.md b/docs/source/legacy/plugin/talk-plugin-sort-most-liked.md similarity index 100% rename from docs/source/plugin/talk-plugin-sort-most-liked.md rename to docs/source/legacy/plugin/talk-plugin-sort-most-liked.md diff --git a/docs/source/plugin/talk-plugin-sort-most-loved.md b/docs/source/legacy/plugin/talk-plugin-sort-most-loved.md similarity index 100% rename from docs/source/plugin/talk-plugin-sort-most-loved.md rename to docs/source/legacy/plugin/talk-plugin-sort-most-loved.md diff --git a/docs/source/plugin/talk-plugin-sort-most-replied.md b/docs/source/legacy/plugin/talk-plugin-sort-most-replied.md similarity index 100% rename from docs/source/plugin/talk-plugin-sort-most-replied.md rename to docs/source/legacy/plugin/talk-plugin-sort-most-replied.md diff --git a/docs/source/plugin/talk-plugin-sort-most-respected.md b/docs/source/legacy/plugin/talk-plugin-sort-most-respected.md similarity index 100% rename from docs/source/plugin/talk-plugin-sort-most-respected.md rename to docs/source/legacy/plugin/talk-plugin-sort-most-respected.md diff --git a/docs/source/plugin/talk-plugin-sort-newest.md b/docs/source/legacy/plugin/talk-plugin-sort-newest.md similarity index 100% rename from docs/source/plugin/talk-plugin-sort-newest.md rename to docs/source/legacy/plugin/talk-plugin-sort-newest.md diff --git a/docs/source/plugin/talk-plugin-sort-oldest.md b/docs/source/legacy/plugin/talk-plugin-sort-oldest.md similarity index 100% rename from docs/source/plugin/talk-plugin-sort-oldest.md rename to docs/source/legacy/plugin/talk-plugin-sort-oldest.md diff --git a/docs/source/plugin/talk-plugin-subscriber.md b/docs/source/legacy/plugin/talk-plugin-subscriber.md similarity index 100% rename from docs/source/plugin/talk-plugin-subscriber.md rename to docs/source/legacy/plugin/talk-plugin-subscriber.md diff --git a/docs/source/plugin/talk-plugin-toxic-comments.md b/docs/source/legacy/plugin/talk-plugin-toxic-comments.md similarity index 100% rename from docs/source/plugin/talk-plugin-toxic-comments.md rename to docs/source/legacy/plugin/talk-plugin-toxic-comments.md diff --git a/docs/source/plugin/talk-plugin-viewing-options.md b/docs/source/legacy/plugin/talk-plugin-viewing-options.md similarity index 100% rename from docs/source/plugin/talk-plugin-viewing-options.md rename to docs/source/legacy/plugin/talk-plugin-viewing-options.md diff --git a/docs/source/plugins/overview.md b/docs/source/legacy/plugins/overview.md similarity index 100% rename from docs/source/plugins/overview.md rename to docs/source/legacy/plugins/overview.md diff --git a/docs/source/plugins/plugins-directory.md b/docs/source/legacy/plugins/plugins-directory.md similarity index 100% rename from docs/source/plugins/plugins-directory.md rename to docs/source/legacy/plugins/plugins-directory.md