-
Notifications
You must be signed in to change notification settings - Fork 2
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
Notebook-gh_pages tutorial or brief notes #1
Comments
Thanks @HobnobMancer - this is a good idea. In general, I think we'll all be happier having to do less maintenance so I would propose that the form of a guide or tutorial to set up notebooks as GitHub Pages should take the form of:
I think this would be helpful to students who might want to take advantage of GiHub Pages, and minimise our maintenance to occasional updates/cleaning out of the links to other sites. What do you think? |
That would be great, thank you.
You're quite correct - I keep forgetting that. I'll update the checklist to reflect that. |
This should be corrected now, with commit 950cf28 |
Pre-issue checklist
Please check that you have taken the steps below:
Summary:
Please provide a short summary of your suggestion or issue (just a couple of sentences).
The
notebooks/README.md
could contain either a tutorial or brief notes on how to set up notebooks to be accessible as Git Pages.Description:
Describe the issue in detail, as clearly as possible. Please be specific wherever you can.
It is mentioned that notebooks can be used along with Git Pages to present their work via a website. It could be highlighted that this also enables the use of interactive plots (maybe an example could be produced to demonstrate this).
The
notebooks/README.md
could contain either a tutorial or brief notes on how to set up notebooks to be accessible as Git Pages. More specifically a quick description on how to compile the URL so that the main Git Page links out to specific Pages generated from a notebook.It's not a difficult process to describe, but I can foresee some confusion arising when trying to generate the links due to not fully understanding or needing a reminder on how Git Pages are constructed. Specifically, to help the students generate the git.io links and not try and link to github repo.
It might reduce how often the same issue keeps cropping up, and it would be good for the CVs to be able to show employers what they have done.
Contributions:
Would you be interested in implementing your suggested improvement or other change? If you are, do you want or need assistance in making any changes in this repository?
I can add it if you like?
Post-issue checklist
Please check that you have taken the steps below
Labels
button in the sidebarLike in the
ncfp
repo, it won't let me @widdowquinnThe text was updated successfully, but these errors were encountered: