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

Missing sufficient documentation Selection-Field-Type #568

Open
TheCadien opened this issue Oct 16, 2020 · 4 comments
Open

Missing sufficient documentation Selection-Field-Type #568

TheCadien opened this issue Oct 16, 2020 · 4 comments

Comments

@TheCadien
Copy link
Member

The Selection-Field-Type Doc is missing Doc about the PHP Class and the Service Config / Service Tag.

Like :
https://github.com/sulu/sulu-workshop/blob/master/config/services.yaml#L44
and
https://github.com/sulu/sulu-workshop/blob/master/src/Content/EventSelectionContentType.php

@alexander-schranz
Copy link
Member

alexander-schranz commented Oct 16, 2020

I think its a little bit confusing but a Field-Type is not automatically a Content-Type. The docs is about the Admin UI and create new entities for it, for this no Content Type is needed.

Content Type are about pages and how a page should render it. Not sure so if admin-ui docs is the correct docs about Content-Type.

@alexander-schranz
Copy link
Member

So I think this is related to #121

@TheCadien
Copy link
Member Author

See your Point. What do you think, is the cookbook the better place:)?

@niklasnatter
Copy link
Contributor

niklasnatter commented Oct 20, 2020

Unfortunately, the documentation about the field-types (and their difference to content-types) is basically not existent 😕 Because of this, its really hard to find a good place for documenting this.

In my opinion, the best solution at the moment would be adding an additional Register PHP content type paragraph/subsection to https://docs.sulu.io/en/latest/book/extend-admin.html#selection-field-type
This section should probably state that this is needed when the selection is used inside of a page and give a short example how to do it.

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

No branches or pull requests

3 participants