Customize tagged view in patterns website

[jawache]

Customize the tagged page view:

• Instead of description show some more meaningful text.
• Ideally show some more information, tags.

[zanete]

Can I clarify what this is about?

• (1) Assuming that instead of the word "Description" under each result here https://patterns.greensoftware.foundation/tags/ it should show the actual description of the resulting doc, e.g. "If service downtimes are acceptable it's better to not strive for highest availability but to design the solution according to real business needs. Lower availability guarantees can help reduce energy consumption by using less infrastructure components." should appear under "Match your service level objectives to business needs"
• (2) "Ideally show some more information, tags." By Tags it's meant to have all the other tags that doc is associated with, e.g for "Match your service level objectives to business needs" it should show CloudReliability/AvailabilityMonitoring

[zanete]

(1) @osamajandali to investigate and see what can be done, but hasn't started yet. If the above is not possible will re-discuss

[zanete]

There is a risk that this might not be done before COP, to be confirmed next week

[osamajandali]

So the solution turns out to be very simple 😄
You need only to add a description in frontmatter of each page file.
here is an example
https://github.com/Green-Software-Foundation/green-software-patterns/blob/main/docs/catalog/ai/serverless-model-development.md?plain=1#L6
so once all the pages are updated with this frontmatter, this issue will be fixed

[holanita]

@osamajandali thanks that's good news I guess. can you do this before cop? cc'ing @zanete so she is aware

[zanete]

@osamajandali can you clarify that this is something you will do or you provided an example for @holanita so that she (or someone else in the team) can do it?

[jawache]

@holanita so I think the ask her is for Bill or someone from the patterns team to go through all the existing patters and add a short description at the top like @osamajandali showed how in here: https://github.com/Green-Software-Foundation/green-software-patterns/blob/main/docs/catalog/ai/serverless-model-development.md?plain=1#L6

@osamajandali can't do this, only the people who know the patterns can do this.

[holanita]

@dubrie @greenhsu123 do you have capacity to add a short description to each pattern as described above? alternatively, if you could list the ones you can take care of, we could ask the team tomorrow to handle the rest.

[greenhsu123]

Sure, I can do the cloud ones.

[dubrie]

Just to clarify from my perspective, we have a description section in each of the patterns already. Is the ask to create a second, shorter, description that goes in the front matter section? Is it possible to use the description as it is today or do we want to re-write new ones for every pattern?

[zanete]

@dubrie (and @osamajandali please correct me if I'm wrong but) I understand that it's difficult to use the existing description in the way is needed because it's part of the whole text and not placed as a tag above it.
To get it to appear on the listing it should be placed also in the top after "description:" as per the example. I believe you can use the one that is already written, which makes this a copy-paste job, no re-writes needed.
cc @holanita

[holanita]

I had the same understanding @zanete. if this is just a copy-paste job, I can do this myself if no one else has time for this.

[holanita]

This has been discussed in today's team meeting. We'll go for the copy-paste option. I will do this tomorrow.

[holanita]

Okay so I've just submitted a PR for AI and WEB, but this seems a bit more tricky than expected.

1. It's interesting to look at all the descriptions at the same time. I might be wrong but now it feels like some describe the problem, while some describe the solution or maybe both.
2. I have shortened some descriptions and kept a few long ones. Might be best to test a long one first to see if something gets cut off - since we don't know the exact character limits (?).
3. I ran out of time and Cloud seems scary :) @greenhsu123 do you still have time to process them? If not, I can continue in the evening. Will be back in about 4 hours!

[greenhsu123]

@holanita ah... i am in Asia at the moment, it will have to wait till tomorrow am for me! could you make a start from the top? and i can catch up from the bottom when i wake up tomorrow :)

[holanita]

No worries, I've just done Cloud too. @dubrie for Cloud I have used the original descriptions in most cases. Some have special characters like colons or urls, so I have removed some sentences from those descriptions.

(I forgot that I should have committed to dev from the beginning so most of them are in a new branch sorry. I had 1 accidental commit in dev and couldn't find away to delete it. Can you do it form pls?)

[holanita]

Thanks for reviewing the PR @dubrie. Just checked all the tags on the website everything seems fine.