-
Notifications
You must be signed in to change notification settings - Fork 100
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 README.md to reference the GUI application. #1173
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is becoming real!
For using the validator with the JAR file, we currently have the following:
- on master, we provide instructions on how to download the latest JAR file from
master
using the GH Actions section (see this section) with a link to DOWNLOAD_SNAPSHOT_JAR.md. - To get the file from a specific release, in the top section of the README.md, the user gets a link to a branch where we replaced the flow described in 1. with the direct link (see the v3.0.0 branch).
I think this is not great because most users skip the top section and end-up getting the file from the GH Actions section, which is overkill for most users, and potentially not what we want since master
is not always stable. Additionally, we can easily forget to update these branches when we have a release (proof: we forgot to do this for the 3.0.1 release).
I think sending the users directly to the release page is much better, and we should replace the "Run the app via the command line" Setup section with the same flow.
This brings me to the question: do we want to keep a link to DOWNLOAD_SNAPSHOT_JAR.md
in the instructions here, in case a user wants to use the latest version of the validator, or to test that a bug is fixed? I think we should provide it, but make sure this is not the flow casual users will take.
@barbeau, thoughts?
In any case, @bdferris-v2 we should create a DOWNLOAD_SNAPSHOT_APP.md
document or modify the existing DOWNLOAD_SNAPSHOT_JAR.md
to describe how to get it from the GH Actions.
I think I'd try to encourage most users to download an official release installer and/or jar. I acknowledge there may be some power users / developers who want to use the latest version at HEAD, but that should be the exception, not the rule. I could take a stab at updating the README to reflect that stance if everyone agrees? |
Okay, thank you 🙏 |
@isabelle-dr I took a stab at updating README. I didn't yet update All that said, I don't think the |
IMHO the JAR snapshots should really be uploaded to the GitHub Maven repo so they show up under the "Packages" section of the repo (versus just uploaded as artifacts of an Action). They are much easier to find that way - it cuts down the number of steps needed in instructions from like 6 to 1. We did this on the gtfs-realtime-validator:
I say all this because if we do the above, then the documentation for the process to download the installer and the JAR snapshots will be different and we shouldn't combine them for now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for the update @bdferris-v2. I just added a suggestion.
Let's address the following points in a follow-up:
- upload JAR snapshots to the GitHub Maven repo
- potentially combining
test_pack_doc.yml
andpackage_installers.yml
Co-authored-by: isabelle-dr <63653518+isabelle-dr@users.noreply.github.com>
…-validator into issue/1172/docs
Closes #1172.
I'm not sure how doc previews work in a PR, but you can also see the rendered updates (including the image) at:
https://github.com/bdferris-v2/gtfs-validator/tree/issue/1172/docs