Closed lpfeif closed 1 year ago
Citation is a required link--what if it's not yet published? "Executable Link" --is it bad that I don't know what this means? Software badges--I also don't know what badges are
Automatically generated JSON for the onboarding request:
{
"active_development": true,
"tool_name": "Lisa's Fake Tool",
"tool_abbreviation": "LFT",
"authors": "Lisa Pfeiffer",
"noaa_internal": true,
"maintainer_name": "Lisa Pfeiffer",
"maintainer_email": "lisa.pfeiffer@noaa.gov",
"background_text": "This tool writes the \"results\" sections of my papers, which is my most hated section. ",
"citation": "website",
"user_organizations": ["NOAA NWFSC"],
"toolbox_drawers": ["General Modeling and Productivity Tools"],
"keywords": ["Economics"],
"uses_github_releases": false
}
thanks @lpfeif for the comments, I think illustrates that those form components need more explanation!
thanks @lpfeif for the comments! I tried to address your comments, but may still need your help in addressing them fully.
Citation is a required link--what if it's not yet published?
I went back and forth on whether it should be required, but then decided that I don't want people just to skip citation since it is a commonly asked question. I added in a sentence to the form about using Zenodo to get a DOI for source code. I think it is pretty easy to use, so I would like to see us use this more!
"Executable Link" --is it bad that I don't know what this means?
Does this description help clarify = Link the compiled version of the tool, if available.
? If not, let me know so I can make this description better.
Software badges--I also don't know what badges are
I added this sentence to the form "Badges are used to indicate important information about software to users." Does that help? I tried to find a link to an article explaining badges but didn't find a good one - maybe this means we should have one in the FIT resources that could be linked in the form.
First two--good! Badges--yes I think we need an article or FIT resources to explain them.
Thank you! I opened an issue for writing the post on badges: https://github.com/noaa-fisheries-integrated-toolbox/resources/issues/39
Active Development
Yes
Tool name
Lisa's Fake Tool
Tool abbreviation
LFT
Author(s)
Lisa Pfeiffer
NOAA Internal
Yes
Maintainer Name
Lisa Pfeiffer
Maintainer Email
lisa.pfeiffer@noaa.gov
Background Text
This tool writes the "results" sections of my papers, which is my most hated section.
Citation
website
References
No response
Associated Tools
No response
User Organizations
NOAA NWFSC
Online App Link
No response
Executable Link
No response
Website Link
No response
Documentation Link
No response
Source Code Link
No response
PDF Download Link
No response
Software Badges
No response
Toolbox Drawers
Keywords
Uses Github Releases
I plan to use them in the near future
Static version number
No response
Comments
No response
Code of Conduct