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 Update doc structure for docs.silverstripe.org #114

Merged
merged 2 commits into from
May 27, 2024

Conversation

GuySartorelli
Copy link
Member

Also remove unnecessary docs and add doc linting

Issue

Copy link
Member Author

@GuySartorelli GuySartorelli left a comment

Choose a reason for hiding this comment

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

Removed the following documentation:

section reason
Filtering with Taxonomy Terms Shows a pretty complex query for a very narrow use case that avoids using the ORM (so, narrow use case with arguably bad practices)
Taxonomy Navigation Seems unlikely you'd want a whole page dedicated to this - you'd probably more likely just want to add this as a part of a pre-existing page.
Even if you do want this, it's pretty straight forward to create a page.
We'll deprecate the built in TaxonomyDirectoryController - that only works for the Page class and only when a relation with a specific name is set up, it's too narrow in purpose

{
$fields = parent::getCMSFields();
// ...
$fields->addFieldToTab('Root.Main', TreeMultiselectField::create(
Copy link
Member Author

Choose a reason for hiding this comment

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

TreeMultiselectField is way more intuitive and lightweight than the old docs saying to use GridField.

Also remove unnecessary docs and add doc linting
@@ -35,7 +36,11 @@
"SilverStripe\\Taxonomy\\Tests\\Behat\\Context\\": "tests/behat/src/"
}
},
"extra": [],
Copy link
Member Author

Choose a reason for hiding this comment

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

Removed unnecessary empty section

Copy link
Member Author

Choose a reason for hiding this comment

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

All changes in this file were just to pass linting.

@emteknetnz emteknetnz merged commit 5801fce into silverstripe:3.2 May 27, 2024
12 checks passed
@emteknetnz emteknetnz deleted the pulls/3.2/update-docs branch May 27, 2024 21:55
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