-
-
Notifications
You must be signed in to change notification settings - Fork 65
Update number for each guide #135
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
Conversation
|
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. 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. |
|
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 |
|
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. |
|
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. |
|
@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. |
|
I’ll just add that, if you want to @tom-tan, you’ll be very welcome to
submit another PR changing the episode filenames and adding the relevant
field into `_config.yml`. All of that pending the upstream PR getting
merged, of course.
…On Fri, 2 Aug 2019 at 15:08, Michael R. Crusoe ***@***.***> wrote:
@tobyhodges <https://github.com/tobyhodges> So exciting, thank you! If
that gets merged then I'll incorporate those changes here and then close
this PR.
@tom-tan <https://github.com/tom-tan> Thank you again for your PR and
starting this conversation.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#135?email_source=notifications&email_token=ACJ62PFSW6OFXJLLLSXRPR3QCQWUZA5CNFSM4GO3CUU2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD3NWEXY#issuecomment-517694047>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/ACJ62PG5GQOVHYOLNZIUGZLQCQWUZANCNFSM4GO3CUUQ>
.
|
|
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 |
|
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 |
|
@mr-c do you want to merge the upstream changes? |
|
@kinow should we make a ticket for this for the new user guide format or is it not relevant anymore? |
|
@swzCuroverse, I think this can be closed as there are no more numbers for episodes 👍 |
A file (or directory) names in directories
_includes/cwland_episodeshave 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.