Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC Document official support for linkfield #457

Merged
merged 1 commit into from
Feb 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions en/04_Optional_Features/index.md
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Original file line number Diff line number Diff line change
@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should either have a newline above this or have both sentences on one line

Copy link
Member Author

@GuySartorelli GuySartorelli Feb 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We explicitly don't have a standard for whether to break up lines or not (this was one of the linting rules we opted not to enable). it doesn't affect anything.


[CHILDREN includeFolders]
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
28 changes: 28 additions & 0 deletions en/04_Changelogs/5.2.0.md → en/08_Changelogs/5.2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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}
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Comment on lines -10 to 12
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an unrelated change - I noticed we don't call out the minor release policy here but we should.


These modules will be supported for the lifetime of Silverstripe CMS 5 in the provided major versions.
Expand Down Expand Up @@ -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
Expand Down
File renamed without changes.
Loading