Skip to content

Conversation

@tom-tan
Copy link
Member

@tom-tan tom-tan commented Jan 9, 2019

A file (or directory) names in directories _includes/cwl and _episodes have to correspond to each guide.
However, some files (for 19 and larger guide) does not correspond to the step number in user guide.

This request renames them. I also update _includes/cwl/conformance-test.yml.

@mr-c
Copy link
Member

mr-c commented Jan 9, 2019

Does this break existing links to the user guide?

@tom-tan
Copy link
Member Author

tom-tan commented Jan 9, 2019

Does this break existing links to the user guide?

Yes. I fixed the links between the guides but links from external websites are affected by this change.
For instance: 19-custom-types/index.html -> 18-custom-types/index.html

Is it possible to make a redirect pages for them?


IMO, using section numbers as file names make them fragile from the future changes such as reorganizing the guide. It would be nice if we can remove section numbers from the file names but it is out of scope of this request.

@stain
Copy link
Member

stain commented May 14, 2019

I agree the number should not be part of the URI (it can be part of the markdown filename if you want, overriding the slug.)

I would suggest closing this PR, and renaming them all to be number-less. To avoid breaking URIs we can re-add the existing names with redirects using the jekyll-redirect-from plugin

@tobyhodges
Copy link
Contributor

The user guide is based on The Carpentries' styles repo (https://github.com/carpentries/styles). The way that things work with that infrastructure means that, if you were to remove the numbers from the filenames, the order of the sections would break - it would become alphabetical by filename.

There is an open discussion Issue about changing that carpentries/styles#236 but, as long as the upstream setup doesn't allow this, I would recommend against changing the numbering system in this repository.

@tobyhodges
Copy link
Contributor

tobyhodges commented Aug 2, 2019

Update: I have submitted a PR to carpentries/styles to allow arbitrary ordering of episodes (instead of numbering). If that gets merged, we can pull the latest changes from the template repository and get started on a more sustainable fix for this problem in the CWL UG.

@mr-c
Copy link
Member

mr-c commented Aug 2, 2019

@tobyhodges So exciting, thank you! If that gets merged then I'll incorporate those changes here and then close this PR.

@tom-tan Thank you again for your PR and starting this conversation.

@tobyhodges
Copy link
Contributor

tobyhodges commented Aug 2, 2019 via email

@tobyhodges
Copy link
Contributor

An update: since we last discussed this, a new version of Jekyll (v4.0.0) was released, which includes a field allowing the order of pages to be specified in _config.yml. GitHub Pages isn't yet using this latest version of Jekyll to build pages, but all the same it didn't feel worth introducing all the extra customisation into the Carpentries' lesson template to achieve this behaviour. Instead, we should simply wait for GH Pages to start using this newer version of Jekyll.

@tobyhodges
Copy link
Contributor

Another update: carpentries/styles#437 was merged, so we can now do this reordering much more easily, without waiting for GitHub Pages to adopt Jekyll v. ≥4. Specify the order of episodes in the episode_order field of _config.yml - see linked PR for more info. @tom-tan would you like to adapt this PR to use the new functionality of the template, then I think we can (finally!) merge this...

@tobyhodges
Copy link
Contributor

@mr-c do you want to merge the upstream changes?

@mr-c
Copy link
Member

mr-c commented Oct 28, 2019

@tom-tan Sure, you can review it at #171

@swzCuroverse
Copy link
Contributor

@kinow should we make a ticket for this for the new user guide format or is it not relevant anymore?

@kinow
Copy link
Member

kinow commented Oct 15, 2022

@swzCuroverse, I think this can be closed as there are no more numbers for episodes 👍

@mr-c mr-c closed this Oct 16, 2022
@mr-c mr-c deleted the rename-cwl-dirs branch October 16, 2022 15:01
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.

7 participants