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

Move the categories to the nuspec & Add wiki page with tools by categories #1107

Closed
Ana06 opened this issue Jul 15, 2024 · 1 comment · Fixed by #1197
Closed

Move the categories to the nuspec & Add wiki page with tools by categories #1107

Ana06 opened this issue Jul 15, 2024 · 1 comment · Fixed by #1197
Assignees
Labels
🌀 FLARE-VM A package or feature to be used by FLARE-VM 💎 enhancement It is working, but it could be better 📄 documentation Improvements or additions to documentation 🏃 CI Related to CI

Comments

@Ana06
Copy link
Member

Ana06 commented Jul 15, 2024

Details

Use GH actions to have two Wiki page that documents the tools and categories:

  • One page should be for users with a header and a table with package name, tool name and tools description per category. This should make it easier to find the tools that we have available.
  • The second page should be for script usage to use it in FLARE-VM/Commando-VM to sort the packages by category in the installer.
@Ana06 Ana06 added 📄 documentation Improvements or additions to documentation 💎 enhancement It is working, but it could be better 🏃 CI Related to CI 🌀 FLARE-VM A package or feature to be used by FLARE-VM labels Jul 15, 2024
@Ana06 Ana06 added this to the FLARE-VM 2024 Q3 - P1 milestone Jul 15, 2024
@Ana06 Ana06 assigned sara-rn and unassigned emtuls Jan 9, 2025
@Ana06
Copy link
Member Author

Ana06 commented Jan 9, 2025

I have discussed with @sara-rn the following implementation proposal, which is more robust than the original proposal:

  • Add a single Packages Wiki page with a table with package name, tool name and tools description per category. This should make it easier to find the tools that we have available. This is addressed in Add GitHub Action to Create Package Wiki #1197.
  • Move the categories to the nuspec. This way we can use the XML https://www.myget.org/F/vm-packages/Packages directly in the FLARE-VM/Commando-VM installers to sort the packages by category (tracked in FLARE-VM in Display packages by category in installer flare-vm#578) and we do NOT need and extra wiki page generated by GH actions. @sara-rn is working on this part. The move of the categories to the nuspec involves:
    • Add the category to the nuspec of all packages (for example in the tags field).
    • Adapt installers and linter. In the packages that use the category to install a shortcut in the Tools directory, take it from the nuspec instead of hard-coding it. I think this should be easy to do, but in case this is not possible, we should add a linter to ensure they are on-sync. In any case, we should adapt the category linter to ensure the nuspec uses a valid category and that the category is accessed in the correct way. We may want to split this into two linters. The changes described in this bullet point need to be in the same PR.
    • Adapt the Packages wiki page introduced in Add GitHub Action to Create Package Wiki #1197 to use the category from the nuspec. I think this is a nice improvement, as it removes the Not Categorized section making this page more useful.

As moving the categories to the nuspec and changing how they are accesses in the install scripts touches all packages. So I recommend we try to merge all PRs that would cause conflicts before sending this change and try to send small atomic PR if possible. For example, adding the categories to the nuspec could be an independent PR.

@Ana06 Ana06 changed the title Add wiki page with tools & categories Move the categories to the nuspec & Add wiki page with tools by categories Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌀 FLARE-VM A package or feature to be used by FLARE-VM 💎 enhancement It is working, but it could be better 📄 documentation Improvements or additions to documentation 🏃 CI Related to CI
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants