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

Optional slug to unbind the notebook from the generated url name #72

Merged
merged 3 commits into from
Nov 24, 2022

Conversation

TuanaCelik
Copy link
Member

In this PR we introduce an optional "slug" entry in the config.
This has some advantages:

  • The url structure is no longer bound to the name of the notebook
    But also disadvantages:
  • The generated markdowns would no longer necessarily share names with the notebook. So It's not so easy to find them if you're looking for them. You would have to go and look at the index.toml to figure out which .md file corresponds to it

Copy link
Contributor

@masci masci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think for new tutorials the problem of having a slug sensibly different from the notebook filename won't be that much of a problem, I'm 👍

scripts/generate_markdowns.py Outdated Show resolved Hide resolved
markdowns/10_Knowledge_Graph.md Outdated Show resolved Hide resolved
@TuanaCelik
Copy link
Member Author

The PR now includes an example "slug" for tutorial 1 which sets the slug to the one it has always been in HSH.
And an additional "Slugs" section in Contributing.md

@TuanaCelik TuanaCelik merged commit 89c6b1d into main Nov 24, 2022
@TuanaCelik TuanaCelik deleted the slug-structure branch November 24, 2022 15:04
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

Successfully merging this pull request may close these issues.

None yet

3 participants