Add support for keywords based search on landscape mode

[mindthegab]

We have several keywords in metadata representing functional characteristics of the project - these should be filterable / searchable in the landscape view.

Tasks:

• [ ] Ability to add keywords into landscape.yml for each item entry (example below)
• [ ] Ability to show keywords for each item in the detail page of l.finos.org (ie https://landscape.finos.org/selected=alloy )
• [ ] Ability to filter projects by keyword (should work like the Organization filter)

Example of a possible landscape keyword structure:

          - item:
            organization:
              name: Finos
            name: Alloy
            homepage_url: 'https://github.com/finos/alloy'
            repo_url: 'https://github.com/finos/alloy'
            logo: alloy.svg
            keywords:
              - modeling
              - data
              - sdlc

[dankohn]

We have search on the todo list but are unlikely to get to it soon: https://github.com/cncf/landscapeapp/issues/25

It also sounds like you would like a faceted search which is possible but would need to be better defined.

[mindthegab]

Thanks For the pointer Dan. Yeah I did think about faceted.

We can build it ourselves and push upstream if needed.

To be clear, as a general statement, we need to address FINOS business goals (the facets would primarily express applicability in different functional areas of the industry) here as a vertical foundation (different from what the LF is used to) and we can’t be limited by the technical framework. So as much as I appreciate limitations we will have to find a way to make it work, and we are willing to put the effort there ourself.

On Wed, Jul 22, 2020 at 9:55 AM Dan Kohn notifications@github.com wrote:

We have search on the todo list but are unlikely to get to it soon: cncf/landscapeapp#25 https://github.com/cncf/landscapeapp/issues/25

It also sounds like you would like a faceted search which is possible but would need to be better defined.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/finos/finos-landscape/issues/49#issuecomment-662561551, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAHKV6H2NLOAWCZMLZKXGQDR44JGFANCNFSM4PE4NMTA .

-- Thanks,

-- Executive Director, Symphony Software Foundation phone: +1 404 432 7652 | twitter: @mindthegabz | blog: mindthegab.com

“Keyboard not found. Press F1 to continue"

[maoo]

@dankohn - thanks for your feedback! I've added more specs in the issue description above; is it clearer now what we're trying to achieve? Please let me know if/how I can help. TY!

[dankohn]

Yes, I think I get the idea. I'll just say for the other 15 landscapeapp users, they've been happy to date with just having two tiers of metadata, which can then fit in the category and subcategory, plus organization, license, project maturity, and location.

We would be happy to accept patches to the upstream landscapeapp to implement keywords.

[mindthegab]

Thanks Dan.

The key difference here is that we are a vertical foundation, as opposed to most LF projects being across industries.

So while the “technical taxonomy” (category x sub-category) we currently built is useful, our first and foremost goal (before even joining the LF) was to have a “functional taxonomy” which maps which projects can be used in which area of the industry to solve concrete business challenges.

Let’s see if we can do this in a lightweight way.

Thanks again for your continued support and advice here! -- Gabriele Columbro Executive Director FINOS, FinTech Open Source Foundation

On Jul 23, 2020, at 6:08 AM, Dan Kohn notifications@github.com wrote:

 Yes, I think I get the idea. I'll just say for the other 15 landscapeapp users, they've been happy to date with just having two tiers of metadata, which can then fit in the category and subcategory, plus organization, license, project maturity, and location.

We would be happy to accept patches to the upstream landscapeapp to implement keywords.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.

[maoo]

Hi @AndreyKozlov1984 - I'd like to pick your brain on this request; did anyone else request this feature? Is this something that is part of the landscapeapp roadmap? Any way we could achieve this with the current landscapeapp features?

Thanks in advance!

[AndreyKozlov1984]

Hi, maoo, if this is the goal of a finos-landscape, I would recommend you to start populating keywords using the extra field, i.e.

  - item:
    logo: test.svg
    extra:
      keywords: ['keyword1', 'keyword2', 'finos']

This will help us to get data populated

[maoo]

Oh, nice!

I could definitely generate those keywords, but before updating the code, I wonder what is going to happen when all our project metadata will be managed via PCC. Given that we won't have access to public/internal APIs, it would be impossible for us to generate the landscape.yml file as we're doing now.

In the spirit of not duplicating efforts, I'd like to know if there's any integration already planned between PCC and the landscapeapp.

TIA!

[AndreyKozlov1984]

I'd like to know what is PCC then! It is possible to access the landscapeapp with API calls, but I'd like to know what source of integration you want to achieve!

[AndreyKozlov1984]

There is nothing what prevents you from fetching landscape.yml, importing there data from your own source, and then committing it back with a cron script

[maoo]

Sorry for the lack of info!

PCC stands for Project Control Center, it's part of LFX and it's going to be the "source of truth" for all FINOS (and all other LF) project metadata - https://docs.linuxfoundation.org/lfx/project-control-center/pcc-dashboard

Yes, I can easily interact with the landscapeapp via API, but if I cannot access PCC APIs, I won't be able to access project data.

[AndreyKozlov1984]

At this moment I can offer you to fill the landscape.yml , as I suggested, with keywords, they will be displayed when you select an individual item, and I'll prepare the landscapeapp to support the search via url

[maoo]

Thanks @AndreyKozlov1984 - looking at https://github.com/cncf/landscape/blob/master/landscape.yml I don't see keywords being used; is this the right field to use, or shall we use summary_tag instead?

We could start by adding category and sub-category as tags, then let the FINOS team iterate on tag definitions.