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

Notebook-gh_pages tutorial or brief notes #1

Open
1 of 2 tasks
HobnobMancer opened this issue May 24, 2022 · 3 comments
Open
1 of 2 tasks

Notebook-gh_pages tutorial or brief notes #1

HobnobMancer opened this issue May 24, 2022 · 3 comments

Comments

@HobnobMancer
Copy link
Contributor

Pre-issue checklist

Please check that you have taken the steps below:

  • Search the Issues pages for related discussions and suggestions

Summary:

Please provide a short summary of your suggestion or issue (just a couple of sentences).
Thenotebooks/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).
Thenotebooks/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

  • Added a suitable label or labels for this issue from the Labels button in the sidebar
    Like in the ncfp repo, it won't let me @widdowquinn
@widdowquinn
Copy link
Contributor

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:

  1. A brief, high-level overview (e.g. save your notebooks as HTML pages, and link to them from the main landing README.md file or from some other interstitial web page.
  2. A list of links (perhaps grouped by topic) to online guides for how to set up GitHub pages, and how to integrate notebook output into them

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?

@widdowquinn
Copy link
Contributor

I can add it if you like?

That would be great, thank you.

  • Like in the ncfp repo, it won't let me [add labels]

You're quite correct - I keep forgetting that. I'll update the checklist to reflect that.

@widdowquinn
Copy link
Contributor

I'll update the checklist to reflect that.

This should be corrected now, with commit 950cf28

@HobnobMancer HobnobMancer mentioned this issue May 28, 2022
15 tasks
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