styles
styles copied to clipboard
carpentries
Render CONTRIBUTING instead of redirecting to GitHub
Currently, the link to "Contribute" in the footer sends to GitHub. Edit the template to render the file and update the links to point to it.
As I am about to go on a "Train the Trainers" workshop, I was reviewing my past suggestions and contributions to the Carpentries, in the light of the current rendering of the Shell Novice lesson, and so came across the latest version of the original "issue", which I believe is more than two-years-old, or so, now.
Good to see that this change is nearing inclusion into the lesson template, however, I wanted to point out that the original thrust that gave rise to the change also asked to see the "Cite" link (as rendered from content that is currently a plain text file in a lesson's repo, as opposed to being a contained within a MarkDown file) treated in the same way as the Contributing link.
For the full story behind this, see:
- https://vuw-ecs-kevin.github.io/offline-capable-lesson/
a pull request to address this would be welcomed!
I didn't know about this resource you created, it's great!
a pull request to address this would be welcomed!
Could I get you to take a look at
- https://github.com/vuw-ecs-kevin/lesson-example/tree/fully-offline-capable
which I think already has the changes required, albeit in a clone of "lesson-example" and not in one of "styles".
It's not clear to me, some two years or so on now, whether the current lesson "publishing model" would need to see the changes made here, in "styles" or whether they'd still best be made to the content of "lesson-example"?
I also note that that branch of my clone of "lesson-example" is a long way behind the head of the carpentries/lesson-example, so would I be best advised to bring the branch in my clone up-to-date before submitting a pull request, or just try and let Git handle things ?
Furthermore, as I am no longer at ECS, VUW, might it be better for me to clone carpentries/lesson-example under my "current" GitHub persona and submit the pull from there ?
Because of the way we use the lesson template, the main repository that is used by the lessons and the workshop websites (styles) cannot have any pages or information in it. lesson-example is a way to have a functional demonstration of the different features used by the template. So, we'd welcome a pull request in styles to make the template fully offline capable. Once the changes are there, we can propagate them to lesson-example the same way we would for the other lessons and repositories that use the template.
I think it'd be easier if you brought the latest version of styles into your branch before submitting a pull request. A few things have changed under the hood and it's possible that some of the modifications you had brought will need to be modified. I'm happy to provide guidance if needed.
It's really up to you to choose where the pull request comes from. It doesn't make a difference to us.
On Fri, 14 Jun 2019 at 18:45, François Michonneau [email protected] wrote:
I think it'd be easier if you brought the latest version of styles into your branch before submitting a pull request. A few things have changed under the hood and it's possible that some of the modifications you had brought will need to be modified. I'm happy to provide guidance if needed.
It's really up to you to choose where the pull request comes from. It doesn't make a difference to us.
In that case I'll probably start again from my current GitHub identity.
Hope to get back to you soon, Kevin
Hope to get back to you soon,
It's a couple of minutes before soon, so
I have just pushed the gh-pages branch of
https://github.com/pawsey-kbuckley/offline-capable-lesson/
up and can see that the rendered version is now available at
https://pawsey-kbuckley.github.io/offline-capable-lesson/
It seems to be doing the right thing when rendered there.
Before I start issuing pull requests from the fully-offline-capable branch
that you can adopt or reject into the main styles repo, could I get you to
take a look at the rendered lesson and perhaps even clone the repo so
that you can see that it works when rendering and browsing locally.
