-
-
Notifications
You must be signed in to change notification settings - Fork 140
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
Rename snippet library sub-directories #226
Comments
It will be convenient if the snippet and lesson have the same name. For example:
I would say
Edited for table formatting |
@Sabryr I'm afraid that including the number defeats part of the purpose of the change. I'm on-board with:
i.e. the snippet directory name could exactly match the text part of the base of the lesson file name. @tkphd What are the modifications required to the lesson-check script? Edited for table formatting |
Thanks for the feedback, @Sabryr and @reida. I tend to prefer @reida's suggestion for the first lesson, producing
I think the easiest "fix" for lesson-check is to drop lines 299 to 307. This would retain checks for duplicate lesson numbers, but would not check whether the numbering increments by 1. |
Issue opened upstream. |
+1 for content-based naming; perhaps we could drop the number from file names too? this would also make reordering easier. |
Good prompt, @jevbelikov. If we want to, we can migrate to manual episode order, and name the Markdown files anything we like. This introduces a small maintenance & training overhead, since the existence and significance of the new |
This commit does the directory-renaming part of issue #226, but retains the sequential integer prefix for the episode file names. Modifying or removing the numerical prefix involves changes to the style code (so tests will still work), and possibly interacting with the upstream Carpentries repo, which I feel should be separated from the directory issue.
For what it's worth, notwithstanding the limited ambition of my PR, I am not opposed to nonsequential numbering, or to removing the numbers and doing manual sequencing. I left that out mostly based on uncertainty about how to coordinate with upstream on those issues. |
Closed in favor of #230 |
At present, each of the sub-directories of each site's snippet catalog (to extend the library metaphor) is named with the numerical value of the lesson it goes with. However, as we see in #225, when new material is inserted, these numbers go out of sync. This is nightmarish to maintain, especially given the number of forks and pull requests that would need updating any time the lesson order changed.
Recommend finding a content-based naming scheme, with some verbosity, to improve maintainability & legibility. Related to #9.
Current
PR #225
Proposed
We would need to modify the lesson-check script to let increasing
numbering sequences to pass, otherwise tests will break.
The text was updated successfully, but these errors were encountered: