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

Update geoips get / describe to add links in output #570

Open
1 of 2 tasks
evrose54 opened this issue May 15, 2024 · 4 comments
Open
1 of 2 tasks

Update geoips get / describe to add links in output #570

evrose54 opened this issue May 15, 2024 · 4 comments
Assignees
Labels
cli Command line interface tasks enhancement New feature or request Priority Low Low priority issues refactor Code refactoring updates

Comments

@evrose54
Copy link
Contributor

evrose54 commented May 15, 2024

Requested Update

Description

We should update the command geoips get (later to be geoips describe) to include in its output a link to the corresponding GeoIPS artifact described in our documentation. For example, if we were to run geoips get interface algorithms, we'd also include an attribute called doclink (or something similar) which would be a url to the corresponding documentation for such artifact.

Background and Motivation

This was a discussion that was held over #444.

Code to demonstrate issue

GeoipsGet command classes.

Checklist

  • update geoips get to describe
  • add links to output
@evrose54 evrose54 added enhancement New feature or request refactor Code refactoring updates labels May 15, 2024
@evrose54 evrose54 self-assigned this May 15, 2024
@evrose54 evrose54 added the cli Command line interface tasks label May 15, 2024
@jsolbrig
Copy link
Contributor

Some things to think about on this issue:

  • Can we somehow make link generation dynamic so we don't have to hard code them? This would require collaboration whoever works on this issue and whoever is working on the documentation.
  • If we can't make link generation dynamic, is it worth it to do this? If so, where do we put the hard-coded links?

@jsolbrig
Copy link
Contributor

@biosafetylvl5 This is the documentation linking issue that I was talking about earlier.

@jsolbrig
Copy link
Contributor

This is blocked by the current broken CI. Need to create an issue to fix the CI. Also blocked by improving the dockerfile.

@jsolbrig
Copy link
Contributor

@jsolbrig: Add blocking issues to this once the issues exist.

@jsolbrig jsolbrig added the Priority Low Low priority issues label Jun 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Command line interface tasks enhancement New feature or request Priority Low Low priority issues refactor Code refactoring updates
Projects
None yet
Development

No branches or pull requests

2 participants