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

README.md file needs instructions updated to the latest release. #204

Open
iMichaela opened this issue Oct 11, 2023 · 1 comment
Open

README.md file needs instructions updated to the latest release. #204

iMichaela opened this issue Oct 11, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@iMichaela
Copy link

Describe the bug

The instructions in the README.md file need to be updated to ensure all developers are always installing the latest oscal-cli version. If maven path is consistent and only the version differs , maybe the version could be treated as a parameter in the installation description.

@iMichaela iMichaela added the bug Something isn't working label Oct 11, 2023
@aj-stein-nist aj-stein-nist added documentation Improvements or additions to documentation and removed bug Something isn't working labels Oct 11, 2023
@aj-stein-nist
Copy link
Collaborator

aj-stein-nist commented Oct 11, 2023

For downloading the CLI from the official Maven OSSRH repositories, there is no alias for LATEST that will allow people to download directly (it would seem from casual interactions most people are using the CLI download it directly from the web-browser or with a HTTP client, like curl or wget, not with the Maven mvn utility where such an alias can be helpful). I can write a more complex shell expansion to alias the latest release, but will be system-specific and make the minimal documentation less approachable to people who do not understand the commands.

That said, I do see some value in improving the documentation. I will want triage this further, but I do not see it as a bug. I have some ideas how to clarify, but it will make the documentation slightly more complicated. Is a comment in the commands that says # Visit this URL and select the latest release sufficient? Somehow, an example URL will need to be in there then.

@aj-stein-nist aj-stein-nist added this to the Future milestone Feb 1, 2024
@aj-stein-nist aj-stein-nist moved this from Needs Triage to Todo in NIST OSCAL Work Board Feb 5, 2024
@aj-stein-nist aj-stein-nist modified the milestones: Future, Next Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

2 participants