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

Change "Site Tree" navigation to redirect to folder landing pages #2933

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

douglaslassance
Copy link

After deploying Wiki.js in our company, we had a lot of feedback from confused users when using the "Site Tree" navigation. This revealed to be due to a couple of interaction facts:

  • Clicking on a folder would not take you to the landing page of that folder, requiring a second click on the landing page to reach the information.
  • Clicking on the landing page would take the navigation back to the level above the landing page folder, making it impossible to read the landing page while seeing the sub-pages of that folder in the nav.

We have explored the other types of navigation but the ability for the "Site Tree" to dynamically display sub-pages was just too valuable. As a result, we decided to patch it by making sure that clicking on a folder would redirect you to that folder's landing page. We also modified the tree to represent the home page as the root and added a redirect to it.

We have no hope or desire to see this request merged in its current state since we are aware of the patched nature of the change. That being said, we thought this could be a great platform to discuss the validity of the feature and the way you'd see it implemented. We obviously would like to avoid having to maintain a fork and are ready to put in the necessary work.

Thank you.

@auto-assign auto-assign bot requested a review from NGPixel January 20, 2021 01:06
@douglaslassance douglaslassance marked this pull request as draft January 20, 2021 01:07
@thoni56
Copy link
Contributor

thoni56 commented Jan 28, 2021

This would be very valuable as a standard or alternative to the current tree navigation which to many is non-intuitive.

It might be an evidence of the fact that there (in my humble opinion) probably is a deeper, almost philosophical, discussion to be had to make Wiki.js the best wiki, but that should probably be taken somewhere else. On the feature request list?

@thoni56
Copy link
Contributor

thoni56 commented Feb 9, 2021

I've tried this PR out and I must say it pretty much nails it. I'm not sure why you consider it of "patched nature" ;-)

It does change some earlier behaviour, yes, so I guess it needs to be discussed in view of that change, but to us it fits the bill and would be happy to see this in.

@douglaslassance
Copy link
Author

douglaslassance commented Feb 9, 2021

I think the main concern is that this should be an option. Either an entirely new navigation mode, either an option on the "Site Tree" mode. Since that's a bit of work, we wanted to make sure that @NGPixel is on board conceptually.

@thoni56
Copy link
Contributor

thoni56 commented Feb 12, 2021

Personally, I can't see how anyone could not see this as an improvement on the current tree navigation, but again, that's just me ;-)

I totally agree that we need @NGPixel onboard here, especially since I've seen a few other aspects that probably would benefit from a change in this direction (where new pages are assumed to end up, what page a link goes to by default when you click on a folder, ...) But all those can be completely separate, smaller, changes.

Me and a few others at my company might be willing to do what we can to help if this is the direction Wiki.js navigation is going.

@NGPixel
Copy link
Member

NGPixel commented Feb 14, 2021

This will be the default behavior in 3.0.

@gmasil
Copy link

gmasil commented Feb 19, 2021

@douglaslassance Thank you very much for this PR. I merged it into my fork and it will definitely stay!
Great improvement for me as I am still trying to convince myself to move from Confluence to Wikijs, now that Atlassian is not interested in smaller dev teams anymore.
Once again, thank you very much!

@Douglasproglima
Copy link

@NGPixel What will be the release date of version 3.0?

@NGPixel
Copy link
Member

NGPixel commented Feb 22, 2021

@NGPixel What will be the release date of version 3.0?

See https://docs.requarks.io/releases

@digitalLumberjack
Copy link

One other instance with this feature :D

Thanks @douglaslassance !

Thanks a lot for wikijs @NGPixel and courage for the 3.0 ! 🚀

@jaimehrubiks
Copy link

jaimehrubiks commented Apr 14, 2022

This is the only thing missing in WikiJS

Edit: Thanks for this patch! I will introduce wikijs to the team just because of it :)

@jonaskello
Copy link

Also found this really confusing. I was thinking it was some kind of bug or that I did something wrong in the setup, but now I found this PR I understand it is confusing by design :-). Is there some easy way to introduce this patch into a container (k8s) setup?

@gmasil
Copy link

gmasil commented Jan 4, 2023

@jonaskello Just create a fork, merge this PR into your fork and then build the docker image on your own as described in the wiki. If you don't need a fork or version control just checkout the repository and apply the patch of this PR from here: 2933.patch using the git command git apply 2933.patch. Then build the docker image.

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.

9 participants