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

Rename listview.md to collectionview.md and update its terminology #6571

Merged
merged 3 commits into from
Oct 22, 2024

Conversation

caronvincent
Copy link
Contributor

@caronvincent caronvincent commented Oct 21, 2024

Description

What did you add/update/change?

The aim of this pull request is to update the contents of the List View documentation page to use the updated terminology from Umbraco CMS 14, where "List view" is now known as "Collection view" and "Content App" is now known as "Workspace View".

Type of suggestion

  • Typo/grammar fix
  • Updated outdated content
  • New content
  • Updates related to a new version
  • Other

Product & version (if relevant)

Umbraco CMS >=14

Deadline (if relevant)

When should the content be published?

N/A

Notes

The Alias has not been changed from Umbraco.ListView as it appears to still be in use in the backoffice.
Some screenshots will eventually need to be updated when the backoffice uses the new terminology as well.

Related issue

Fixes #6553

@sofietoft
Copy link
Contributor

Thanks for the PR @caronvincent ! 💪

I noticed from the UI in a 14 project, that the Property Editor is called "Collection" and not "Collection View" 🤔
Looks like it's the UI schema that's called Collection View.

image

I think we should update it to "Collection" 😄 You up for it?

Also, you mention in your description, that you're also making some changes to Content App vs Workspace View.
It don't see any files with changes related to that? 🤔

@caronvincent
Copy link
Contributor Author

@sofietoft Thank you for the feedback.

I noticed from the UI in a 14 project, that the Property Editor is called "Collection" and not "Collection View" 🤔
Looks like it's the UI schema that's called Collection View.
I think we should update it to "Collection" 😄 You up for it?

To be clear on what you'd like me to do: since the backoffice refers to "Collection Property Editor" and not "Collection View Property Editor", all mentions of "Collection View" that I made in my PR should be changed to just "Collection" instead?

Also, you mention in your description, that you're also making some changes to Content App vs Workspace View.
It don't see any files with changes related to that? 🤔

In collectionview.md (formerly listview.md), all mentions of "Content App" have been replaced by "Workspace View".
The changes in my PR so far are limited to collectionview.md as that was the file designated in issue #6553, however I can confirm that other files in the documentation refer to "content app".
Would you like me to expand the scope of this PR to change these other files as well?

@sofietoft
Copy link
Contributor

Yes, please replace all "Collection View"s with "Collection".

Thanks for clearing up about the Content App mentions!
I think the scope of this PR is fine for now.
You're more than welcome though, to do another where you replace the Content App references 🙌

@caronvincent
Copy link
Contributor Author

Understood, I will update mentions of "Collection View" in favor of "Collection".

I will limit this PR to this particular file, but it may be a good idea to create a new issue asking contributors to update mentions of "Content App" in favor of "Workspace View" across the entire documentation. It would make for an easy Hacktoberfest grab, much like the issue I am addressing with this PR.

@sofietoft
Copy link
Contributor

That is very true and a great idea.
I'll add an issue to the tracker 🙌

@caronvincent
Copy link
Contributor Author

I have pushed commit f7206cc to fix the terminology as discussed.

Copy link
Contributor

@sofietoft sofietoft left a comment

Choose a reason for hiding this comment

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

Looks great @caronvincent 🙌

I've added a couple of suggestions to shorten a couple of sentences.
Also, we'll need a redirect for the renamed article.

The following line should be added to the bottom of the redirect list in the .gitbook.yaml file within the 14/umbraco-cms directory:

fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/listview: fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/collection.md

@caronvincent
Copy link
Contributor Author

Done!

@sofietoft
Copy link
Contributor

Excellent! Let's get this one merged then 😄

Thanks again for making this PR helping us getting this up to date 💪 MUCH appreciated!

@sofietoft sofietoft merged commit 259dce3 into umbraco:main Oct 22, 2024
17 checks passed
@nul800sebastiaan
Copy link
Member

Thanks again @caronvincent!

Just a hint: as you may know, this PR qualifies for Umbraco's Hacktoberfest participation for which you can earn rewards.
If you were to make 1 more contribution in the next few days, would be great to see your contributions qualify! You can do it.. 😉

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

Successfully merging this pull request may close these issues.

Collection (formerly ListView) Article for v14+ needs updated terminology
3 participants