-
Notifications
You must be signed in to change notification settings - Fork 18
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
Reorganize folders of DataScienceTutorials.jl #218
Conversation
Tried to make sure they are indeed useless
Mainly the structure, adding tutorials, publishing updates sections for clarity and to match most recent folder reorg.
|
||
* Be sure the version of Julia declared near the top of `index.md` |
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 refers to the old index.md
. The referred to part is now in how-to-run-code
hence the change.
@EssamWisam I'm very happy for you to make an executive decision about these details. Feel free to rewrite these instructions as much as you like. Since the original developer has moved on, just go ahead do your best. You are the active maintainer with the most knowledge about the how the process now works and I will defer to you on this. Do ping me when you are ready for final review. |
Alright. Ready for review. Here is a pretty print of the new README for easier review. The rest as can be seen are folder organization changes. I tested rendering the website after I did those. |
Co-authored-by: Anthony Blaom, PhD <[email protected]>
|
||
### Fixing an existing tutorial | ||
* Find the corresponding Julia script in `_literate` and fix it in a PR. | ||
* Ensure it works and renders properly as explained in [this section](#👀-visualise-modifications-locally). |
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 internal link (and another like it) do not seem to work, at least in the preview.
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.
Well, I followed this which claims it works on Github and it does work locally for me. Let's merge and if it doesn't work I will make rightaway make a PR when I see it to replace it with "as in the... section below" or similar.
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 looks great, thanks. Just the few minor points.
Co-authored-by: Anthony Blaom, PhD <[email protected]>
This includes removing useless files, reorganizing common ones together, centralizing the routing index at the top-level and most importantly using a folder layout instead of prefixes to distinguish different tutorial types.