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

confusing documentation for Publish.yml workflow #53

Open
rambunctiousapple opened this issue Apr 30, 2022 · 0 comments
Open

confusing documentation for Publish.yml workflow #53

rambunctiousapple opened this issue Apr 30, 2022 · 0 comments

Comments

@rambunctiousapple
Copy link

rambunctiousapple commented Apr 30, 2022

on this page https://michaelhatherly.github.io/Publish.jl/dev/docs/getting_started.html there is this line:

Open it up in an editor and find the line with

julia --project=.. -e 'using Publish, USER; deploy(USER; root="/USER.jl", label="dev")'
and edit the USER to be what is needed to build your project correctly. 

Why USER instead of YourPackageName, or something similar? I found this very confusing. I'm willing to rewrite this part of the documentation if my understanding of what you mean is correct. Maybe also add a comment in the .yml file immediately before the line:

#IMPORTANT replace USER with the name of your project
julia --project=.. -e 'using Publish, USER; deploy(USER; root="/USER.jl", label="dev")'

Also, the information about how to edit the Publish.yml file is only in the dev documentation, not in the 0.1.0 version. Somebody who doesn't look at the dev docs, e.g. me for quite a while, will have no idea how to modify the Publish.yml file to get their documentation to deploy correctly on github.

Shouldn't this part of the documentation also be in the 0.1.0 version of the docs?

This is another source of error that could be detected by a check_for_errors() program, that would look up the project name and check to see if the substitution for USER had been made in the Publish.yml file and warn the user if it hasn't. Or maybe make the change automatically and rewrite the Publish.yml file.

If you are okay with the idea I'll take a crack at writing this check_for_errors() program.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
1 participant