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

9.0 DOCS: Node hidden vs disabled #4312

Open
mhsdesign opened this issue Jun 6, 2023 · 8 comments
Open

9.0 DOCS: Node hidden vs disabled #4312

mhsdesign opened this issue Jun 6, 2023 · 8 comments

Comments

@mhsdesign
Copy link
Member

mhsdesign commented Jun 6, 2023

Previously in neos 8.3 you could hide a node. This is now called disabled (see command)

@bwaidelich described it as:

What we sometimes call “hide” is actually a disable (and that’s how the event is called with Neos 9 and IMO we should reflect that in the UI as well).
I could even imagine, hiding (pun intended) disabled nodes from the document tree by default and adding some kind of “recycle bin” view… But I’m getting side-tracked: My point is that we simply can’t know whether the user…

I would like to have the differentiation and mind shift documented (maybe in the php doc codes) so people can understand ^^

the VisibilityConstraints seem to need docs in general:

or maybe here in the command?

The general problem might be that integrators are familiar with the term hidden in neos but not with disabled im now conflicted myself how to name the property in the nodeType templates package ^^

So any definition would be welcome ;)

@bwaidelich
Copy link
Member

The good old "hiddenInIndex" makes sense => The page won't appear in Menus, but it can still be navigated to.
"hidden" didn't really make sense, because it's not that the page is just hidden and you can find it if you only have the correct URL. That node does not exist (as far as the frontend is concerned) but it can be reactivated.

A bit similar to files you put into the recycler (vs files you hide from the file explorer/finder)

@Sebobo
Copy link
Member

Sebobo commented Jun 7, 2023

IMO we have to be a bit careful with naming and where we use "technically" correct terms and where we use terms that our users actually understand.
Whenever I read CR related technical text, I'm getting quite confused and have trouble "translating" it to the people I help on a daily basis.

Do we have some glossary that we can review and discuss at some point?

@mhsdesign
Copy link
Member Author

Im not sure i get how it all relates together. My brain could manage VisibilityConstraints and DisableNodeAggregate but now im a bit confused by: NodeHiddenState (especially why is it hidden, and why can it NOT answer the question whether a Node is hidden because some node above it has been hidden?)

@mhsdesign mhsdesign changed the title 9.0 Document hidden vs disabled 9.0 DOCS: Node hidden vs * disabled Jun 7, 2023
@mhsdesign mhsdesign changed the title 9.0 DOCS: Node hidden vs * disabled 9.0 DOCS: Node hidden vs disabled Jun 7, 2023
@bwaidelich
Copy link
Member

IMO we have to be a bit careful with naming and where we use "technically" correct terms
and where we use terms that our users actually understand.

I fully agree and I also stumbled upon the many new names and concepts in the new CR.

Do we have some glossary that we can review and discuss at some point?

I don't think so, but we urgently need that on docs.neos.io – I created an issue for that and put it on the project board (#4314)

im a bit confused by: NodeHiddenState

Yes, that name is a left-over and it should be named NodeDisabledState – or better yet, be extended to all kinds of attributes (see #4315

@mhsdesign
Copy link
Member Author

I just found this on docs neos io

https://docs.neos.io/guide/contributing-to-neos/event-sourced-content-repository/enabled-and-disabled-nodes

In the old CR, this was called “hidden”, but we felt that enabled and disabled captured the intent better.

If a node is disabled, the system should behave as if this node would not exist. This means:

  • you are not able to query for this node
  • you are not able to query for any child node: If you removed the node, all children would be removed as well.
  • these rules must only apply in frontend, when viewing the site. In backend, you should still see the disabled nodes, so that you can e.g. enable them again.

@mhsdesign
Copy link
Member Author

Also this is the pr fyi which renamed it to disabled ^^

neos/contentrepository-development-collection#94

@mhsdesign
Copy link
Member Author

@dlubitz and me just wondered how far we would like to take this naming decision. Eg should this also be reflected in labels of the Neos Ui

#4817 (comment)

@mhsdesign
Copy link
Member Author

@bwaidelich @kitsunet @grebaldi and me discussed to align the naming also in the Ui to "Disabled" (at least in english) In german "Deaktivieren" "Ausschalten" ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

No branches or pull requests

4 participants