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

Conversation

GuySartorelli
Copy link
Member

Description

Documents providing official support for silverstripe/linkfield 4.0.0

Note that this PR assumes the related PR is merged to pull linkfield docs from the linkfield repository.
The renamed files are so that a new "Optional Features" section can be inserted between "developer guides" and "upgrading".
The "optional features" section will be effectively the same as the userhelp docs in that it will pull content from other repositories (for the scope of the current work, just linkfield).

Issues

Pull request checklist

  • The target branch is correct
  • All commits are relevant to the purpose of the PR (e.g. no TODO comments, unrelated rewording/restructuring, or arbitrary changes)
    • Small amounts of additional changes are usually okay, but if it makes it hard to concentrate on the relevant changes, ask for the unrelated changes to be reverted, and submitted as a separate PR.
  • The commit messages follow our commit message guidelines
  • The PR follows our contribution guidelines
  • The changes follow our writing style guide
  • Code examples follow our coding conventions
  • CI is green

Copy link
Member Author

Choose a reason for hiding this comment

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

Comment on lines -10 to 12
- 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).
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.

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.


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 sorely missing from earlier versions including:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This release of the module includes a bunch of features that were sorely missing from earlier versions including:
This release of the module includes a bunch of features that were missing from earlier versions including:

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Comment on lines 49 to 53
- 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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- 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.
- 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.

Copy link
Member Author

Choose a reason for hiding this comment

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

The old company style guide was very explicit about list styles but since the new one is less strict I'll make this change.

@emteknetnz emteknetnz merged commit 22fd700 into silverstripe:5 Feb 18, 2024
3 checks passed
@emteknetnz emteknetnz deleted the pulls/5/linkfield branch February 18, 2024 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants