-
-
Notifications
You must be signed in to change notification settings - Fork 278
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
MBS-12841 / MBS-8242: Link to edit and relationship docs from edits #2876
base: master
Are you sure you want to change the base?
Conversation
Didn’t review yet, just noted that it now has conflicts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Linking to the documentation is a must have, thank you for dealing with this.
At first glance, there are some issues with the current submission:
- It doesn’t seem helpful to remove the link to the documentation for all edit types in the sidebar.
- When an edit is replacing a relationship by another one of a different type, it is not clear which relationship type the help is about. There should probably be two help buttons in such case.
- The help icon is too far away. It should probably just be by the text as in the external links editor.
- The text in the tooltip should directly show the type’s description as in the external links editor.
Also do not hesitate to ask our design consultant some input on this.
I'll leave 3 and 4 to Aerozol :)
|
Saving one click. The sidebar is not crowded either.
Not this exact kind of edit, I trusted your screenshot. I also had 4. in mind. |
I just don't see when that main list is ever relevant to any specific edit, honestly :) |
I’ve just put this branch on
Note that there is no such help button in relationship editor at the moment. |
Hmm. I was only showing the types for relationships, because for edits there's only ever one type per edit and the type name is in large font on the heading. But if you feel it's useful for that, we could add it? |
105d125
to
1af2e8d
Compare
Thanks reo! |
You missed the point 4. What is in the tooltip for relationship type in the external links editor is the description of the relationship type, not just its name, so the user doesn’t even have to click the link in most cases. |
I did miss that! I would like people to actually go and read the guidelines too, but it might be good to show more here - that just means we need to load it first though since I guess it's not loaded at the moment (unlike when editing). |
This is only shown when viewing one edit at a time, and does not point to docs for the specific edit either, but to a generic page. It should be replaced by a documentation link that is visible from the edit header on any edit view.
1af2e8d
to
440791a
Compare
This adds a link to the doc page for the specific edit type in question to the header of every edit, be it on an edit list or on the edit page itself. This replaces the generic "Edit Types" link on the sidebar (not shown on edit lists) that was removed in the previous commit.
This was probably copied from Create or other place where the structure was different, but here {link} is inside {relationship}.
I'm using this outside the relationship editor in the next commit, so it seems cleaner to move it here.
Changed this to actually show more info about the relationships as requested by @yvanzo (seems like a good call): It also now does "See the documentation for this edit type: Edit relationship." on the edit type popup, as requested by @Aerozol. The UI still seems kind of atrocious, though. @Aerozol, wanna play with it? :) (I understand you can now run code locally). |
This adds a link to the doc page(s) for the relationship type(s) involved in a relationship edit (add, edit or remove), and lists the type descriptions for a basic overview. It seems very useful to have direct links to the documentation (often including specific guidelines) directly in the place people need to vote on the changes from. We pass an array to allow multiple types in EditRelationship; we pass the rels through a Set to remove duplicates when EditRelationship does not change the rel type.
Implement MBS-12841, MBS-8242
Problem
Edit listings could always benefit from more ways to help voters make the right choice. Right now, there's two pieces of documentation we have and would almost certainly be good to show, but we are not linking in any way. One is the edit type documentation for the edit (the data there is not great, but it's being improved with #2784 and should be improved further by actually documenting each edit type). The other is the documentation for relationship types involved in relationship edits (which usually have guidelines! which we don't have a way to access from the edit!).
Solution
The second commit here adds a link to the doc page for the specific edit type in question to the header of every edit, be it on an edit list or on the edit page itself. This replaces the generic "Edit Types" link on the sidebar (not shown on edit lists) that I remove in the first commit.
The last commit adds a link to the doc page(s) for the relationship type(s) involved in a relationship edit (add, edit or remove). Rather than making it float by each relationship, I put it on the top right of the changes display, since @Aerozol suggested we should aim to have help boxes on the top right.
While testing that commit I found that types weren't being loaded properly for relationship removals - fixed with the third commit.
Testing
Manually, using a bunch of relevant edits that happened to already be on my local sample data history from my previous tests for other PRs. A good testing suggestion would honestly just be to play with edit searches, but make sure you navigate to the edit pages as well to check the help works there too.