DOC Document official support for linkfield (#457)

silverstripe · Feb 18, 2024 · 22fd700 · 22fd700
1 parent fee67b6
commit 22fd700
Show file tree

Hide file tree

Showing 45 changed files with 43 additions and 1 deletion.
diff --git a/en/04_Optional_Features/index.md b/en/04_Optional_Features/index.md
@@ -0,0 +1,12 @@
+---
+title: Optional features
+---
+
+# Optional features
+
+Silverstripe CMS can be highly customised using both supported and community-made modules. You can find these [one Packagist](https://packagist.org/?type=silverstripe-vendormodule).
+
+This section highlights some of the CMS features provided by the [Silverstripe CMS supported modules](/project_governance/supported_modules/).
+In each case you'll need to ensure you have the module installed in your project in order to use the features described here.
+
+[CHILDREN includeFolders]
diff --git a/...grading/01_Keeping_projects_up_to_date.md → ...grading/01_Keeping_projects_up_to_date.md b/...grading/01_Keeping_projects_up_to_date.md → ...grading/01_Keeping_projects_up_to_date.md
diff --git a/en/03_Upgrading/07_Deprecations.md → en/06_Upgrading/07_Deprecations.md b/en/03_Upgrading/07_Deprecations.md → en/06_Upgrading/07_Deprecations.md
diff --git a/en/03_Upgrading/index.md → en/06_Upgrading/index.md b/en/03_Upgrading/index.md → en/06_Upgrading/index.md
diff --git a/en/04_Changelogs/5.0.0.md → en/08_Changelogs/5.0.0.md b/en/04_Changelogs/5.0.0.md → en/08_Changelogs/5.0.0.md
diff --git a/en/04_Changelogs/5.1.0.md → en/08_Changelogs/5.1.0.md b/en/04_Changelogs/5.1.0.md → en/08_Changelogs/5.1.0.md
diff --git a/en/04_Changelogs/5.2.0.md → en/08_Changelogs/5.2.0.md b/en/04_Changelogs/5.2.0.md → en/08_Changelogs/5.2.0.md
@@ -7,6 +7,7 @@ title: 5.2.0 (unreleased)
 ## Overview
 
 - [Security considerations](#security-considerations)
+- [Official support for `silverstripe/linkfield`](#linkfield)
 - [Features and enhancements](#features-and-enhancements)
   - [New ORM features](#new-orm-features)
   - [GridField components now work with arbitrary data](#gridfield-arbitrary-data)
@@ -35,6 +36,33 @@ We have provided a severity rating of the vulnerabilities below based on the CVS
 - [CVE-2023-48714 - Record titles for restricted records can be viewed if exposed by GridFieldAddExistingAutocompleter](https://www.silverstripe.org/download/security-releases/cve-2023-48714) Severity: Medium
 - [CVE-2023-44401 - View permissions are bypassed for paginated lists of ORM data in GraphQL queries](https://www.silverstripe.org/download/security-releases/cve-2023-44401) Severity: Medium
 
+## Official support for `silverstripe/linkfield` {#linkfield}
+
+[`silverstripe/linkfield`](https://github.com/silverstripe/silverstripe-linkfield) 4.0.0 has been released and is now a commercially supported module.
+
+That means it is now covered by our [minor release policy](/project_governance/minor_release_policy/), our [major release policy](/project_governance/major_release_policy/), and our [security release process](/contributing/managing_security_issues).
+
+This module provides a [`Link`](api:SilverStripe\LinkField\Models\Link) model and two new form fields: [`LinkField`](api:SilverStripe\LinkField\Form\LinkField) and [`MultiLinkField`](api:SilverStripe\LinkField\Form\MultiLinkField). The intention of the module is to provide a clear and consistent approach to managing links in the CMS.
+
+This release of the module includes a bunch of features that were missing from earlier versions including:
+
+- Support for `has_many` relations
+- Versioned support
+- Validation
+- The ability to declare which link types are allowed per field
+- Improved UI including better keyboard navigation.
+
+> [!NOTE]
+> `silverstripe/linkfield` 4.0.0 requires `silverstripe/framework` 5.2.0 or higher due to its reliance on some new API.
+
+You can install it as soon as you update your project.
+
+```bash
+composer require silverstripe/linkfield
+```
+
+Check out [the linkfield documentation](/optional_features/linkfield/) which includes guides to migrate from similar modules that you might already be using.
+
 ## Features and enhancements
 
 ### New ORM features {#new-orm-features}

diff --git a/en/04_Changelogs/_images/cms22screenie.jpg → en/08_Changelogs/_images/cms22screenie.jpg b/en/04_Changelogs/_images/cms22screenie.jpg → en/08_Changelogs/_images/cms22screenie.jpg
diff --git a/en/04_Changelogs/_images/file-indicators.png → en/08_Changelogs/_images/file-indicators.png b/en/04_Changelogs/_images/file-indicators.png → en/08_Changelogs/_images/file-indicators.png
diff --git a/..._Changelogs/_images/file-status-icons.png → ..._Changelogs/_images/file-status-icons.png b/..._Changelogs/_images/file-status-icons.png → ..._Changelogs/_images/file-status-icons.png
diff --git a/en/04_Changelogs/_images/tab-paths-after.png → en/08_Changelogs/_images/tab-paths-after.png b/en/04_Changelogs/_images/tab-paths-after.png → en/08_Changelogs/_images/tab-paths-after.png
diff --git a/...4_Changelogs/_images/tab-paths-before.png → ...8_Changelogs/_images/tab-paths-before.png b/...4_Changelogs/_images/tab-paths-before.png → ...8_Changelogs/_images/tab-paths-before.png
diff --git a/...hangelogs/_images/tab-paths-customtab.png → ...hangelogs/_images/tab-paths-customtab.png b/...hangelogs/_images/tab-paths-customtab.png → ...hangelogs/_images/tab-paths-customtab.png
diff --git a/en/04_Changelogs/alpha/5.0.0-alpha1.md → en/08_Changelogs/alpha/5.0.0-alpha1.md b/en/04_Changelogs/alpha/5.0.0-alpha1.md → en/08_Changelogs/alpha/5.0.0-alpha1.md
diff --git a/en/04_Changelogs/alpha/index.md → en/08_Changelogs/alpha/index.md b/en/04_Changelogs/alpha/index.md → en/08_Changelogs/alpha/index.md
diff --git a/en/04_Changelogs/beta/5.0.0-beta1.md → en/08_Changelogs/beta/5.0.0-beta1.md b/en/04_Changelogs/beta/5.0.0-beta1.md → en/08_Changelogs/beta/5.0.0-beta1.md
diff --git a/en/04_Changelogs/beta/5.1.0-beta1.md → en/08_Changelogs/beta/5.1.0-beta1.md b/en/04_Changelogs/beta/5.1.0-beta1.md → en/08_Changelogs/beta/5.1.0-beta1.md
diff --git a/en/04_Changelogs/beta/index.md → en/08_Changelogs/beta/index.md b/en/04_Changelogs/beta/index.md → en/08_Changelogs/beta/index.md
diff --git a/en/04_Changelogs/index.md → en/08_Changelogs/index.md b/en/04_Changelogs/index.md → en/08_Changelogs/index.md
diff --git a/en/04_Changelogs/rc/5.0.0-rc1.md → en/08_Changelogs/rc/5.0.0-rc1.md b/en/04_Changelogs/rc/5.0.0-rc1.md → en/08_Changelogs/rc/5.0.0-rc1.md
diff --git a/en/04_Changelogs/rc/5.1.0-rc1.md → en/08_Changelogs/rc/5.1.0-rc1.md b/en/04_Changelogs/rc/5.1.0-rc1.md → en/08_Changelogs/rc/5.1.0-rc1.md
diff --git a/en/04_Changelogs/rc/index.md → en/08_Changelogs/rc/index.md b/en/04_Changelogs/rc/index.md → en/08_Changelogs/rc/index.md
diff --git a/en/05_Contributing/00_Issues_and_Bugs.md → en/10_Contributing/00_Issues_and_Bugs.md b/en/05_Contributing/00_Issues_and_Bugs.md → en/10_Contributing/00_Issues_and_Bugs.md
diff --git a/en/05_Contributing/01_Code.md → en/10_Contributing/01_Code.md b/en/05_Contributing/01_Code.md → en/10_Contributing/01_Code.md
diff --git a/en/05_Contributing/02_Documentation.md → en/10_Contributing/02_Documentation.md b/en/05_Contributing/02_Documentation.md → en/10_Contributing/02_Documentation.md
diff --git a/en/05_Contributing/03_Translations.md → en/10_Contributing/03_Translations.md b/en/05_Contributing/03_Translations.md → en/10_Contributing/03_Translations.md
diff --git a/..._Conventions/01_PHP_Coding_Conventions.md → ..._Conventions/01_PHP_Coding_Conventions.md b/..._Conventions/01_PHP_Coding_Conventions.md → ..._Conventions/01_PHP_Coding_Conventions.md
diff --git a/...tions/02_JavaScript_Coding_Conventions.md → ...tions/02_JavaScript_Coding_Conventions.md b/...tions/02_JavaScript_Coding_Conventions.md → ...tions/02_JavaScript_Coding_Conventions.md
diff --git a/..._Conventions/03_CSS_Coding_Conventions.md → ..._Conventions/03_CSS_Coding_Conventions.md b/..._Conventions/03_CSS_Coding_Conventions.md → ..._Conventions/03_CSS_Coding_Conventions.md
diff --git a/...ntributing/05_Coding_Conventions/index.md → ...ntributing/05_Coding_Conventions/index.md b/...ntributing/05_Coding_Conventions/index.md → ...ntributing/05_Coding_Conventions/index.md
diff --git a/en/05_Contributing/06_Build_Tooling.md → en/10_Contributing/06_Build_Tooling.md b/en/05_Contributing/06_Build_Tooling.md → en/10_Contributing/06_Build_Tooling.md
diff --git a/en/05_Contributing/08_Triage_Resources.md → en/10_Contributing/08_Triage_Resources.md b/en/05_Contributing/08_Triage_Resources.md → en/10_Contributing/08_Triage_Resources.md
diff --git a/en/05_Contributing/09_Release_Process.md → en/10_Contributing/09_Release_Process.md b/en/05_Contributing/09_Release_Process.md → en/10_Contributing/09_Release_Process.md
diff --git a/...ntributing/10_Managing_Security_Issues.md → ...ntributing/10_Managing_Security_Issues.md b/...ntributing/10_Managing_Security_Issues.md → ...ntributing/10_Managing_Security_Issues.md
diff --git a/en/05_Contributing/index.md → en/10_Contributing/index.md b/en/05_Contributing/index.md → en/10_Contributing/index.md
diff --git a/..._Project_Governance/01_Core_committers.md → ..._Project_Governance/01_Core_committers.md b/..._Project_Governance/01_Core_committers.md → ..._Project_Governance/01_Core_committers.md
diff --git a/..._Project_Governance/02_Code_of_conduct.md → ..._Project_Governance/02_Code_of_conduct.md b/..._Project_Governance/02_Code_of_conduct.md → ..._Project_Governance/02_Code_of_conduct.md
diff --git a/...ct_Governance/03_Maintainer_Guidelines.md → ...ct_Governance/03_Maintainer_Guidelines.md b/...ct_Governance/03_Maintainer_Guidelines.md → ...ct_Governance/03_Maintainer_Guidelines.md
diff --git a/...ject_Governance/04_Request_for_comment.md → ...ject_Governance/04_Request_for_comment.md b/...ject_Governance/04_Request_for_comment.md → ...ject_Governance/04_Request_for_comment.md
diff --git a/...ect_Governance/05_Major_release_policy.md → ...ect_Governance/05_Major_release_policy.md b/...ect_Governance/05_Major_release_policy.md → ...ect_Governance/05_Major_release_policy.md
diff --git a/...ect_Governance/06_Minor_release_policy.md → ...ect_Governance/06_Minor_release_policy.md b/...ect_Governance/06_Minor_release_policy.md → ...ect_Governance/06_Minor_release_policy.md
diff --git a/...roject_Governance/07_Supported_Modules.md → ...roject_Governance/07_Supported_Modules.md b/...roject_Governance/07_Supported_Modules.md → ...roject_Governance/07_Supported_Modules.md
@@ -7,7 +7,8 @@ description: Modules which are commercially supported by Silverstripe
 
 Silverstripe CMS ships modules that receive commercial support. Commercially supported modules receive regular updates to work with the latest Silverstripe CMS release. Their [public API](/project_governance/public_api/) conforms to [semantic versioning](https://semver.org/). They are covered by:
 
-- our [security release process](/contributing/managing_security_issues) and
+- our [security release process](/contributing/managing_security_issues)
+- our [minor release policy](minor_release_policy)
 - our [major release policy](major_release_policy).
 
 These modules will be supported for the lifetime of Silverstripe CMS 5 in the provided major versions.
@@ -75,6 +76,7 @@ Supported PHP Module | Supported versions
 [silverstripe/hybridsessions](https://packagist.org/packages/silverstripe/hybridsessions) | 3
 [silverstripe/iframe](https://packagist.org/packages/silverstripe/iframe) | 3
 [silverstripe/ldap](https://packagist.org/packages/silverstripe/ldap) | 2
+[silverstripe/linkfield](https://packagist.org/packages/silverstripe/linkfield) | 4
 [silverstripe/lumberjack](https://packagist.org/packages/silverstripe/lumberjack) | 3
 [silverstripe/mfa](https://packagist.org/packages/silverstripe/mfa) | 5
 [silverstripe/realme](https://packagist.org/packages/silverstripe/realme) | 5

diff --git a/...oject_Governance/08_Fixed_dependencies.md → ...oject_Governance/08_Fixed_dependencies.md b/...oject_Governance/08_Fixed_dependencies.md → ...oject_Governance/08_Fixed_dependencies.md
diff --git a/en/06_Project_Governance/08_Public_API.md → en/12_Project_Governance/08_Public_API.md b/en/06_Project_Governance/08_Public_API.md → en/12_Project_Governance/08_Public_API.md
diff --git a/en/06_Project_Governance/index.md → en/12_Project_Governance/index.md b/en/06_Project_Governance/index.md → en/12_Project_Governance/index.md