craftercms · alhambrav · Mar 6, 2025 · May 22, 2025 · May 23, 2025 · May 30, 2025
diff --git a/source/_static/api/deployer.html b/source/_static/api/deployer.html
diff --git a/source/_static/api/engine.html b/source/_static/api/engine.html
diff --git a/source/_static/api/profile.html b/source/_static/api/profile.html
diff --git a/source/_static/api/social.html b/source/_static/api/social.html
diff --git a/source/_static/api/studio.html b/source/_static/api/studio.html
diff --git a/source/by-role/developer/common/adding-a-new-language.rst b/source/by-role/developer/common/adding-a-new-language.rst
@@ -1,5 +1,5 @@
 :is-up-to-date: True
-:last-updated: 4.1.2
+:last-updated: 5.0.0
 
 .. _adding-a-new-language:
 
@@ -10,9 +10,9 @@ Crafter Studio has been translated into a number of languages. To reach more use
 
 **Here are the steps to add a new language in Crafter Studio:**
 
-#. Add the new language to the ``get-available-languages`` API
-#. In Studio UI, add your new locale files to ui/app/src/translations. You may start by copying ``es.json`` and translating it into your target language.
+#. Add the new language to the ``getAvailableLanguages`` API
 #. Open the file ``ui/app/src/utils/i18n.ts`` and add the locale code to ``createIntlInstance`` conditional statement, and add the switch statement case to ``fetchLocale``.
+#. In Studio UI, add your new locale files to ui/app/src/translations. You may start by copying ``es.json`` and translating it into your target language.
 #. Add the translation file/s for legacy forms and content type editor to ``studio-ui/static-assets/components/cstudio-common/resources/**/base.js``
 #. Update templates to add the new language imports into the runtime (i.e. via script[src] elements)
 #. Build, deploy and test your changes
@@ -26,62 +26,45 @@ Before we begin, we need to pick the two letter language code for the new langua
 Let's begin adding the language ``Japanese`` to Crafter Studio:
 
 ----------------------------------------------------------
-1. Add the new language to the get-available-languages API
+1. Add the new language to the available_languages API
 ----------------------------------------------------------
-* To add the new language to the ``get-available-languages`` API (*/studio/api/1/services/api/1/server/get-available-languages.json*), in your ``studio`` code, navigate to ``studio/src/main/webapp/default-site/scripts/rest/api/1/server`` and open the ``get-available-languages.get.groovy`` file
-* Add the new language to the file:
+* To add the new language to the :base_url:`getAvailableLanguages <_static/api/studio.html#tag/system/operation/getAvailableLanguages>`, in your Studio configuration override file, ``studio-config-override.yaml``, add the new language:
 
-  .. code-block:: groovy
-     :emphasize-lines: 14-16
+  .. code-block:: yaml
+     :caption: *CRAFTER_HOME/bin/apache-tomcat/shared/classes/crafter/studio/extension/studio-config-override.yaml*
+     :emphasize-lines: 10-11
      :linenos:
 
-     def result = []
-    	result[0] = [:]
-    	result[0].id = "en"
-    	result[0].label = "English"
-    	result[1] = [:]
-    	result[1].id = "es"
-    	result[1].label = "español"
-    	result[2] = [:]
-    	result[2].id = "ko"
-    	result[2].label = "한국어"
-    	result[3] = [:]
-    	result[3].id = "de"
-    	result[3].label = "Deutsch"
-        result[4] = [:]
-        result[4].id = "ja"
-        result[4].label = "日本語"
-     return result
+     studio.configuration.availableLanguages:
+         - id: en
+           label: English
+         - id: es
+           label: Español
+         - id: ko
+           label: 한국어
+         - id: de
+           label: Deutsch
+         - id: ja
+           label: 日本語
+
 
 ---------------------------------------------------------
 2. Add the New Language to the React Translations Manager
 ---------------------------------------------------------
-Open the file ``ui/app/src/utils/i18n.ts`` and add the locale code to the ``createIntlInstance`` conditional statement, and add the switch statement case to ``fetchLocale``.
+In your ``studio-ui`` code, open the file ``ui/app/src/utils/i18n.ts`` and add the locale code to the ``createIntlInstance`` conditional statement, and add the new language ``ja`` to the ``ImportsLookup``.
 
 .. code-block:: ts
-    :emphasize-lines: 1,13-15,23,28
-
-    async function fetchLocale(locale: string): Promise<LookupTable<string>> {
-      let translations;
-      switch (locale) {
-        case 'de':
-          translations = await import('../translations/de.json');
-          break;
-        case 'es':
-          translations = await import('../translations/es.json');
-          break;
-        case 'ko':
-          translations = await import('../translations/ko.json');
-          break;
-        case 'ja':
-          translations = await import('../translations/ja.json');
-          break;
-        default:
-          translations = Promise.resolve({});
-          break;
-      }
-      return translations;
-    }
+    :caption: *studio-ui/ui/app/src/utils/i18n.ts*
+    :emphasize-lines: 1,5,10,15
+
+    const importsLookup: ImportsLookup = {
+	    de: () => import('../translations/de.json'),
+	    es: () => import('../translations/es.json'),
+	    ko: () => import('../translations/ko.json'),
+	    ja: () => import('../translations/ja.json')
+    };
+
+    ...
 
     async function createIntlInstance(localeCode: string): Promise<IntlShape> {
       localeCode = localeCode.replace('kr', 'ko');
@@ -93,25 +76,26 @@ Open the file ``ui/app/src/utils/i18n.ts`` and add the locale code to the ``crea
         let fetchedTranslations = await fetchLocale(localeCode as BundledLocaleCodes);
         ...
 
---------------------------------------------------------
-3. Add Your New Locale File/s to ui/app/src/translations
---------------------------------------------------------
+------------------------------------------------------------------
+3. Add Your New Locale File/s to studio-ui/ui/app/src/translations
+------------------------------------------------------------------
 In your ``studio-ui`` code, add the new locale files to ``ui/app/src/translations``. You may start by copying ``es.json`` and translating it into your target language.
 
 .. code-block:: json
     :force:
-    :caption: *ui/app/src/translations/ja.json*
+    :caption: *studio-ui/ui/app/src/translations/ja.json*
 
     {
-      "+E4CL4": "プロジェクト全体が公開されました",
-      "/A7dEh": "最後の投稿はエラーで完了しました、詳細についてはログを参照してください。",
-      ...
-      "about.versionNumber": "バージョン番号",
-      "aboutView.attribution": "CrafterCMS 他の人のおかげでそれは可能です <a>オープンソースソフトウェアプロジェクト</a>.",
-      "accountManagement.changeHelperText": "パスワードが正常に更新されると、再度ログインするように求められます.",
-      "accountManagement.changeLanguage": "言語の変更",
-      "accountManagement.changePassword": "パスワードを変更する",
-      ...
+        "+E4CL4": "プロジェクト全体が公開されました",
+        "+fYahR": "サポートタイプ",
+        "+vOP15": "コンテンツの名称変更",
+        ...
+        "about.versionNumber": "バージョン番号",
+        "aboutView.attribution": "CrafterCMS 他の人のおかげでそれは可能です <a>オープンソースソフトウェアプロジェクト</a>.",
+        "accountManagement.changeHelperText": "パスワードが正常に更新されると、再度ログインするように求められます.",
+        "accountManagement.changeLanguage": "言語の変更",
+        "accountManagement.changePassword": "パスワードを変更する",
+        ...
     }
 
 --------------------------------------------------------------------
@@ -139,7 +123,7 @@ In your ``studio-ui`` code, add the new locale files to ``ui/app/src/translation
       <script src="/studio/static-assets/components/cstudio-common/resources/de/base.js"></script>
       <script src="/studio/static-assets/components/cstudio-common/resources/ja/base.js"></script>
 
-.. code-block:: html
+  .. code-block:: html
       :force:
       :linenos:
       :emphasize-lines: 5
@@ -163,18 +147,20 @@ In your ``studio-ui`` code, add the new locale files to ``ui/app/src/translation
        :caption: *studio-ui/static-assets/components/cstudio-common/resources/ja/base.js*
        :linenos:
 
-       CStudioAuthoring.Messages.registerBundle("siteDashboard", "ja", {
-       dashboardTitle: "ダッシュボード",
+       CStudioAuthoring.Messages.registerBundle('siteDashboard', 'ja', {
+       dashboardTitle: 'ダッシュボード',
 
-       dashboardCollapseAll: "すべて折りたたむ",
+       dashboardCollapseAll: 'すべて折りたたむ',
        ...
 
-Remember to change the language code in the all the ``registerBundle`` calls in the ``base.js`` file
+  Remember to change the language code in all the ``registerBundle`` calls in the ``base.js`` file
 
   .. code-block:: js
 
-     CStudioAuthoring.Messages.registerBundle("dialogs", "ja", {
-
+      CStudioAuthoring.Messages.registerBundle('siteDashboard', 'ja', {
+      ...
+      CStudioAuthoring.Messages.registerBundle('contextnav', 'ja', {
+      ...
 
 --------------------------------------
 6. Build, deploy and test your changes

diff --git a/source/by-role/developer/upgrade/index.rst b/source/by-role/developer/upgrade/index.rst
@@ -24,11 +24,6 @@ From 4.0 to 4.1
 ---------------
 Upgrading to CrafterCMS 4.1 from 4.0 is a simple process. The upgrade script will handle most of the changes for you.
 
----------------
-From 3.1 to 4.1
----------------
-Upgrading to CrafterCMS 4.1 from 3.1 is a bit more involved. Please follow the steps in the guide to upgrade your project/site.
-
 
 .. _upgrade-search:
 
@@ -44,8 +39,6 @@ The indexes may need to be regenerated, and the upgrade script will handle this
 
 When upgrading from 4.0.x (running ES 7) the indices are not compatible at all, so the content needs to be reprocessed and indices rebuilt completely, which is handled by the post-upgrade script, as mentioned above.
 
-When upgrading from 3.1.x (running ES 6), we'll use the ``upgrade-search.sh`` script, which tells the search engine to re-index internally to the new format.
-
 See :ref:`upgrading-search` for more information on upgrading your search from Elasticsearch to OpenSearch along with some manual updates that may be required in some instances.
 
 --------------------------

diff --git a/source/by-role/system-admin/upgrade/index.rst b/source/by-role/system-admin/upgrade/index.rst
@@ -1,5 +1,5 @@
 :is-up-to-date: True
-:last-updated: 4.5.0
+:last-updated: 5.0.0
 
 .. _upgrading-craftercms:
 
@@ -11,13 +11,13 @@ The following CrafterCMS versions are able to upgrade to the latest release:
 
 .. list-table::
 
-    * - **4.5**
+    * - **5.0**
+      - **4.5**
       - **4.4**
       - **4.3**
       - **4.2**
       - **4.1**
       - **4.0**
-      - **3.1**
     * - All
       - All
       - All
@@ -99,147 +99,6 @@ Starting version 4.1.0, CrafterCMS now uses OpenSearch instead of Elasticsearch.
 
 |hr|
 
-.. _upgrading-mongodb:
-
------------------
-Upgrading MongoDB
------------------
-.. note::
-    The following section only applies to Crafter Profile and Social installs.
-
-Crafter Profile and Social version 4.1.0 and later uses MongoDB v6 in the install.
-When upgrading your 3.1.x install of Crafter Profile and Social to 4.1.0 and later, MongoDB will need to be manually upgraded.
-
-This section describes how to upgrade MongoDB in your Crafter Profile and Social version 3.1.x installed on a server.
-
-Please read through the upgrade instructions :ref:`here <upgrading-craftercms-on-a-server>` first.
-The steps for upgrading MongoDB in your Crafter Profile and Social install follows almost exactly
-the same steps as listed in that document.
-
-.. important::
-    Remember to **manually shut down and backup CrafterCMS** before beginning your upgrades!
-
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Upgrading 3.1.x -> 4.1.x (from MongoDB 3.x)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-#. Download CrafterCMS version 4.1.x, and extract the files.
-#. Run the ``upgrade-search.sh`` script from your newly extracted files.
-
-   .. code-block:: bash
-       :caption: *Run the upgrade-search script*
-       :emphasize-lines: 1
-
-       > ./upgrade-search.sh /path/of/install/to/be/upgraded --stay-alive
-       ========================================================================
-       Search upgrade started
-       ========================================================================
-       Downloading Elasticsearch 7 from https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.10.0-linux-x86_64.tar.gz
-       ...
-       All indices reindex complete
-       Reindex finished in 12.843 seconds
-       'stay-alive' flag on, hit enter to stop Elasticsearch
-       >
-       End process. Stop Elasticsearch
-       Move indexes from 'data/indexes-es' to 'indexes'
-       ========================================================================
-       Search upgrade completed
-       ========================================================================
-
-   |
-
-   See :ref:`upgrading-search` for more information on upgrading search.
-
-#. Upgrade using the ``upgrade-target.sh`` script from your newly extracted files. First, we'll need to set ``MONGODB_HOME`` so that the backup script will run with the ``mongod`` version ``3.4.4`` in the old installation before running the ``upgrade-target.sh``:
-
-   .. code-block:: bash
-       :caption: *Set MONGODB_HOME and Run the upgrade-target script from the newly extracted files*
-
-       > MONGODB_HOME=/path/of/3.1.x/install/bin/mongodb ./upgrade-target.sh /path/of/install/to/be/upgraded
-       ...
-       [o] Overwriting file apache-tomcat/LICENSE with the new release version
-       [o] Overwriting file apache-tomcat/BUILDING.txt with the new release version
-       ========================================================================
-       Upgrade completed
-       ========================================================================
-       !!! Please read the release notes and make any necessary manual changes, then run the post upgrade script:
-
-  |
-
-#. Manually upgrade MongoDB from version ``3.4.4`` to version ``6.0.12``.
-   We need to upgrade from each release version and run the ``setFeatureCompatibilityVersion`` command against the admin database.
-
-   Please see https://www.mongodb.com/docs/manual/release-notes/6.0-upgrade-standalone/ for more information on upgrading MongoDB.
-
-   Download and extract the following MongoDB versions available from https://www.mongodb.com/try/download/community:
-
-   - 3.6.23 (http://downloads.mongodb.org/linux/mongodb-linux-x86_64-3.6.0.tgz)
-   - 4.0.28 (http://downloads.mongodb.org/linux/mongodb-linux-x86_64-4.0.28.tgz)
-   - 4.2.25 (https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1804-4.2.25.tgz)
-   - 4.4.26 (https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu2004-4.4.26.tgz)
-   - 5.0.23 (https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu2004-5.0.23.tgz)
-   - 6.0.12 (https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu2204-6.0.12.tgz)
-
-   Run ``mongod`` from each release version ``/extracted/location/of/mongodb-version-to-be-upgraded-to/bin/mongod`` starting from the oldest one:
-
-   .. code-block:: bash
-       :caption: *Run mongod from MongoDB version to be upgraded to*
-       :emphasize-lines: 9
-
-       $ /extracted/location/of/mongodb-linux-x86_64-3.6.23/bin/mongod --dbpath=/path/of/3.1.x/install/data/mongodb --directoryperdb --journal --port 27020
-       ...
-       2023-12-20T02:38:20.546-0500 I CONTROL  [initandlisten] db version v3.6.23
-       2023-12-20T12-03T02:38:20.546-0500 I CONTROL  [initandlisten] git version: d352e6a4764659e0d0350ce77279de3c1f243e5c
-       2023-12-20T02:38:20.546-0500 I CONTROL  [initandlisten] OpenSSL version: OpenSSL 1.1.1g  21 Apr 2020
-       2023-12-20T02:38:20.546-0500 I CONTROL  [initandlisten] allocator: system
-       ...
-       2023-12-20T02:38:21.687-0500 I NETWORK  [initandlisten] listening via socket bound to /tmp/mongodb-27020.sock
-       2023-12-20T02:38:21.687-0500 I NETWORK  [initandlisten] waiting for connections on port 27020
-       2023-12-20T02:38:21.687-0500 I STORAGE  [LogicalSessionCacheRefresh] createCollection: config.system.sessions with generated UUID: fee195e0-b337-498f-8ad9-1c410748bce1
-
-   |
-
-   Then login as user admin in mongoDB in your 3.1.x install and set the compatibility version using the command
-   ``db.adminCommand( { setFeatureCompatibilityVersion: "{version}" } )``
-
-   .. code-block:: bash
-       :caption: *Set compatibility version from /path/of/3.1.x/install/bin/mongodb/bin/*
-       :emphasize-lines: 1,7
-
-       > ./mongosh mongodb://localhost:27020/admin
-       Current Mongosh Log ID:	659511008267cb24aff1427e
-       Connecting to:		mongodb://localhost:27020/admin?directConnection=true&serverSelectionTimeoutMS=2000&appName=mongosh+1.8.0
-       Using MongoDB:		3.6.23
-       Using Mongosh:		1.8.0
-
-       admin> db.adminCommand( { setFeatureCompatibilityVersion: "3.6" } )
-       { ok: 1 }
-       admin>
-
-   |
-
-   Repeat the steps above for all the other versions of MongoDB downloaded in ascending order of version, e.g.
-   run ``mongod`` version ``4.0.28``, then set the feature compatibility version to ``4.0``.  Next run
-   ``mongod`` version ``4.2.25``, then set the feature compatibility version to ``4.2``, and so on and so forth
-
-#. Before starting CrafterCMS, you'll need to configure the installation root directory to use Java version 17.  Remember to read the release notes or any relevant upgrade articles and make any necessary manual changes before running the `post-upgrade.sh`` script as described next
-
-#. Run the ``post-upgrade.sh`` script. This will:
-
-   - Remove old *data/indexes-es* directory (old indexes are not usable by OpenSearch)
-   - Start CrafterCMS and ask for signal to continue
-   - Once started and CrafterCMS is up (including UM execution), let the post-upgrade continue by typing ``Y``:
-
-     .. code-block:: bash
-
-         Please make sure Crafter has started successfully before continuing
-         > Continue? [(Y)es/(N)o]:
-
-   - Post-upgrade will continue to trigger the reindex of all targets by calling the Deployer API ``/api/1/target/deploy-all``
-
-#. Your install is now upgraded and you may login to Studio to check the version.
-
-|hr|
-
 ------------------------------
 Troubleshooting Upgrade Issues
 ------------------------------