mattbrailsford/umbraco-fluidity

Documentation for Real World Examples?

Nicholas-Westby opened this issue · 5 comments

Nicholas-Westby commented

My coworkers and I have built a few sections in Umbraco using Fluidity, including:

  • Reviews - Shows reviews for physical stores. Allows back office users to approve reviews for display on the site.
  • Logs - A read-only view of logs related to API calls to a specific CRM we use. Useful so we can check if API calls are failing or taking too long.
  • Storage Units - A read-only view of storage units. Allows us to easily confirm if an import of storage units worked.
  • Redirects - Allows redirects to be edited (we store them in a tab delimited text file). Uses a customer Fluidity repository to interact with the text file.
  • Customers - A read-only view of customer information. Allows us to troubleshoot more easily when we're only given partial information about a customer (i.e., we can look up additional information for a given customer).
  • Locations - A read-only view of physical store locations. We mainly use this to find the URL of a location page given the ID (not an Umbraco ID) of the location. Uses a custom Fluidity repository to fetch the data from Umbraco content nodes.

My thought is that the documentation website (https://umco.github.io/umbraco-fluidity/) could have a section with "real world examples" of Fluidity, complete with screenshots and code (maybe even a video if you feel it's appropriate). I could contribute some items to this section.

I bet that'd make it easier for people to get up and running with Fluidity quickly (e.g., they could pick an example that's similar to their use case and copy it so they don't have to start from scratch).

What do you think? Useful? Should I contribute a PR with one of these so you can see what it might look like and so you know whether or not I should add more of them?

akeilox commented

This sounds great!
The learning curve, or initiation, would be greatly improved with examples such as you mentioned.

refex commented

Hi, that would be really great. The documentation api is extensive but it lacks of some real word example

Nicholas-Westby commented

It's been a few months and I haven't heard from the maintainers of this project (assuming @akeilox and @refex are not maintainers), so I assume there is no interest on their end. I'll close this now.

mattbrailsford commented

You're welcome to submit a PR 👍

Nicholas-Westby commented

@mattbrailsford Cool, I'll see if I can find some time in the next few weeks. I'll probably start with a small example before I invest too much time to see if it's something you agree with.

(Reopening issue.)

  • 👍1