waltz icon indicating copy to clipboard operation
waltz copied to clipboard

Technology Panel: Best Practices and Documentation for Implementation

Open TL41 opened this issue 1 year ago • 3 comments

Description

We're looking for more guidance around populating and using the Technology panel.

I see some documentation in the repo but I think some added insight would be helpful:

  • https://github.com/finos/waltz/blob/master/docs/design/draft/software_usage/README.md
  • https://github.com/finos/waltz/blob/master/docs/features/servers_and_databases/README.md

I’ve done some research on this in the code and it looks like there are 3 ‘types’ of data that can be available in that Technology section: Server, Database, and Software

With that, I see database tables that seem to be related

  • Server
    • server_information
    • server_usage
  • Database
    • database_information
    • database_usage
  • Software
    • software_package
    • software_usage
    • software_version
    • software_version_licence
    • software_version_vulnerability

We can help contribute to documentation

TL41 avatar Jan 10 '24 02:01 TL41

If you could help document that would be great! How about I revisit the documentation we have and then we could schedule a follow up call to review and agree on needed documentation improvements ?

davidwatkins73 avatar Jan 10 '24 16:01 davidwatkins73

That sounds great! We'll continue to work through what we can in the meantime. Thanks!

TL41 avatar Jan 10 '24 16:01 TL41

I think I have a good handle on this now. I've opened an issue because it does not seem that we can generate Software Catalog info from the data generators - https://github.com/finos/waltz/issues/6933

TL41 avatar Jan 15 '24 05:01 TL41