search

carpentries / styles

Styles for The Carpentries lessons. No README to avoid merge conflicts with lessons. Demo 👇
https://carpentries.github.io/lesson-example
Other
84 stars 96 forks source link

Add a Readme #574

Closed baileythegreen closed 3 years ago

baileythegreen commented 3 years ago

to this repo because the single sentence in its description does not provide enough information to make up for the ambiguous name of the repo.

Ideally, the Readme would include some detailed explanation of how this repo differs in its intended use from https://github.com/carpentries/carpentries-theme, given that Jekyll themes are basically rules for styling pages.

I am not able to propose a suitable Readme in a PR myself because I do not completely understand the purpose of this repo....

fmichonneau commented 3 years ago

I think we can't have a README for this repo because it would lead to confusing merge conflicts when updating the template in the lesson repositories.

baileythegreen commented 3 years ago

Could that be solved by adding the Readme to .gitignore?

If not, can the description be expanded, at least?

maxim-belkin commented 3 years ago

because I do not completely understand the purpose of this repo....

This repo is the backbone of The Carpentries lessons -- navigation bar, icons, stylesheets, etc. The Carpentries lessons use Jekyll / GitHub pages, so without this repo one would have to set up all the styles manually and every lesson would look different.

This repo is mentioned in the Lesson Example and in the Curriculum Development Handbook - 1, 2.

Could that be solved by adding the Readme to .gitignore?

No. .gitignore file tells Git to not include specified files in the repository. This (usually) means that if a file is listed in .gitignore, you won't see it on GitHub (well, unless you add --force that file).

If not, can the description be expanded, at least?

Text in the description box used to say something else: my fork -- https://github.com/maxim-belkin/styles -- has the following wording in it: Styles for SWC/DC sites: no README to avoid merge conflicts w/ those repos. Raniere Silva's fork -- https://github.com/rgaiacs/swc-styles -- says CSS and other style material shared across multiple sites. Perhaps, something like Styles for The Carpentries lessons. No README to avoid merge conflicts with lessons. would be better?

maxim-belkin commented 3 years ago

The description has been updated.