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

joss-paper: Build tutorials not described #336

Closed
PetrKryslUCSD opened this issue Jul 26, 2020 · 5 comments
Closed

joss-paper: Build tutorials not described #336

PetrKryslUCSD opened this issue Jul 26, 2020 · 5 comments
Milestone

Comments

@PetrKryslUCSD
Copy link

The readme does not describe how to get the tutorial notebooks opened from a cloned repository. In particular, when the repository is cloned, there are no notebooks. They need to be built. The build step is not documented. It appears to be activate/instantiate/build.
Then one can open a notebook with IJulia.notebook().

@fverdugo
Copy link
Member

Related to openjournals/joss-reviews#2520

@fverdugo fverdugo added this to the JOSS paper milestone Jul 27, 2020
@fverdugo
Copy link
Member

@PetrKryslUCSD The steps to clone, build and open the notebooks of the Gridap tutorials are explained in the documentation pages of the tutorials repository https://gridap.github.io/Tutorials/stable/

In the read-me file of https://github.com/gridap/Tutorials there is a link to the documentation pages. Do you believe this is not enough?

@PetrKryslUCSD
Copy link
Author

My comment was based on the order in which the user would proceed. If I start with the readme, follow the link to the stable version of the tutorials, and click on the first tutorial I can see how to run it in the mybinder, but I don't know how to run it on my own machine. So I go back to the readme.

Honestly, I missed the description that is below the list of tutorials. My bad. But I think it points to a possible reorganization where the documentation of the tutorials starts with instructions on how to run them, and then follows the list of tutorials.

Just a suggestion.

@fverdugo
Copy link
Member

fverdugo commented Aug 5, 2020

Perhaps the problem is that the instructions on how to build the notebooks are not in the section called How to start.

https://gridap.github.io/Tutorials/stable/#How-to-start-1

I'll try to fix this.

@fverdugo
Copy link
Member

fverdugo commented Aug 5, 2020

Hi @PetrKryslUCSD

I have rewritten the confusing part. I hope that now it is better:

https://gridap.github.io/Tutorials/v0.12/

If you are happy with the changes, please close the issue.

Thanks!

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

No branches or pull requests

2 participants