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

Links and references view via content menu [Add Links to item view] #4787

Merged
merged 24 commits into from
Jul 16, 2023

Conversation

pgrunewald
Copy link
Contributor

@pgrunewald pgrunewald commented May 18, 2023

Show references to the current content item (backlinks) of

  • links in text
  • related contnet
  • any custom relation

Cursor_and_Supervisor_Adélaïde_Pickavance

TODO:

  • Reflect latest changes of relations endpoint here
  • Review UI by an UX expert
  • Opt-out via settings: Do not add content menu item for "Links and References"
  • Add tests

[Edit] References (not just links) to item (view and menu item) – Update to released plone.restapi.relations #4842
grafik

See the user documentation preview : https://deploy-preview-4787--volto.netlify.app/user-manual/links-to-item.html

@netlify
Copy link

netlify bot commented May 18, 2023

Deploy Preview for volto ready!

Name Link
🔨 Latest commit 9ea3700
🔍 Latest deploy log https://app.netlify.com/sites/volto/deploys/64b4277f4fc9310008fa9382
😎 Deploy Preview https://deploy-preview-4787--volto.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@cypress
Copy link

cypress bot commented May 18, 2023

Passing run #6365 ↗︎

0 75 5 0 Flakiness 0

Details:

Merge branch 'master' into links-to-item-view
Project: Volto Commit: 9ea37005c2
Status: Passed Duration: 09:20 💡
Started: Jul 16, 2023 6:51 PM Ended: Jul 16, 2023 7:00 PM

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.

Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

This is so good! I love seeing more docs for the Volto manual. I especially appreciate that the screenshot is narrow and is therefore legible on narrow screens.

Aside from my specific suggestions, for the general docs style, would you please put each sentence is on one line? Then it is good to go.

docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
@pgrunewald
Copy link
Contributor Author

Thanks for having a look into the docs, @stevepiercy. I incorporated all changes.

Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

Some suggestions were not committed, possibly due to merging lines. Please take another look at these. Thank you!

docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
docs/source/user-manual/links-to-item.md Outdated Show resolved Hide resolved
@pgrunewald
Copy link
Contributor Author

pgrunewald commented May 23, 2023

Some suggestions were not committed, possibly due to merging lines. Please take another look at these. Thank you!

Ok, they are all in. Thanks for your hints! I also squashed the last commits, because they all about minor docs fixes. You might want to reset, e.g.: git reset --hard origin/links-to-item-view.

@stevepiercy
Copy link
Collaborator

This PR needs a Change log entry.

Also a couple of jobs fail and need to be addressed.

Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

I don't know why a few suggestions got dropped, so I went ahead and committed them.

I approve the docs only. A maintainer should review the code. Thank you!

@stevepiercy
Copy link
Collaborator

Preview of docs: Finding links to the current item

Base automatically changed from relations-control-panel to master May 23, 2023 21:59
@stevepiercy
Copy link
Collaborator

@pgrunewald two more jobs are failing, related to code analysis and i18n, the latter of which may have recently changed from another merged PR. Would you please correct these, then request review from a maintainer of Volto?

@pgrunewald
Copy link
Contributor Author

@stevepiercy Will do! I think over the weekend i will find some time to fixing these issues. I also added small TODO list in my initial comment. So others get an idea what's still missing.

@sneridagh sneridagh added this to the 17.x.x milestone Jun 20, 2023
@ksuess ksuess changed the title Add Links to item view Links and references view via content menu [Add Links to item view] Jun 20, 2023
Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

A couple of MyST syntax improvements and questions

docs/source/configuration/settings-reference.md Outdated Show resolved Hide resolved
docs/source/configuration/settings-reference.md Outdated Show resolved Hide resolved
@@ -2387,6 +2409,11 @@ msgstr ""
msgid "Origin"
msgstr ""

#: components/manage/LinksToItem/LinksToItem
# defaultMessage: Overview and management of relations of all content items
Copy link
Collaborator

Choose a reason for hiding this comment

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

Will the addition of this message string require an update to the screen shots?

Is a user truly able to manage relations from this panel, or only look at an overview? If the latter:

Suggested change
# defaultMessage: Overview and management of relations of all content items
# defaultMessage: Overview of relations of all content items

...and update all instances of the message.

Copy link
Member

Choose a reason for hiding this comment

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

Will the addition of this message string require an update to the screen shots?

The button linking to the relations control panel is only for site managers. Therefore I prefer not to mention this in the user documentation.

Copy link
Member

Choose a reason for hiding this comment

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

Is a user truly able to manage relations from this panel, or only look at an overview?

He/she is indeed able to modify relations. That's the bonus of the new relations control panel. But as the main intent of this content menu addition is about providing a view with the backlinks/references to this page (content item) in text, and not with custom relations, the reduction to 'overview' is fine.

ksuess and others added 2 commits June 21, 2023 10:10
Co-authored-by: Steve Piercy <web@stevepiercy.com>
@ksuess ksuess requested a review from stevepiercy June 21, 2023 08:42
Copy link
Collaborator

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

Thank you!

@ksuess ksuess requested review from nileshgulia1 and a team June 22, 2023 15:37
@sneridagh sneridagh requested a review from davisagli June 28, 2023 07:10
@sneridagh sneridagh modified the milestones: 17.x.x, Plone 6.1 Jul 4, 2023
@sneridagh sneridagh merged commit 3bc1910 into master Jul 16, 2023
39 checks passed
@sneridagh sneridagh deleted the links-to-item-view branch July 16, 2023 19:01
sneridagh added a commit that referenced this pull request Jul 24, 2023
* master: (42 commits)
  make selectedView and className props available for Search block (#4997)
  Release @plone/volto-testing 4.0.0-alpha.0
  Release 17.0.0-alpha.21
  Upgrade to Cypress 12.17.1 (latest) (#4981)
  Image rendering (#3337)
  feat(Url.js): add getFieldURL helper function to get the url value of a field based on its structure (#4731)
  Handle @linkintegrity response with items but no breaches (#4832)
  Release 17.0.0-alpha.20
  Use all the apiExpanders in use, so we perform a single request for getting all the required data. (#4946)
  Fix the condition deciding on listing pagination format so it takes into account container blocks as well (#4978)
  Release 17.0.0-alpha.19
  Fix search block input clear button doesn't reset the search (#4837)
  Add /ok route as an express middleware (#4432)
  handles condition for yearly frequency in recurrence (#4604)
  Remove dangling out of place Guillotina Cypress tests (#4980)
  Update to latest plone.restapi and Plone 6.0.6 (#4979)
  Update browserlist (#4977)
  `Links and references` view via content menu [Add `Links to item` view] (#4787)
  Release 17.0.0-alpha.18
  Toc responsive (#4912)
  ...
sneridagh added a commit that referenced this pull request Nov 14, 2023
…w] (#4787)

Co-authored-by: Steve Piercy <web@stevepiercy.com>
Co-authored-by: Katja Süss <k.suess@rohberg.ch>
Co-authored-by: Víctor Fernández de Alba <sneridagh@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants