Skip to content
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

Changed all instances of TJ Alumbaugh's email address #818

Merged
merged 1 commit into from
Feb 2, 2018

Conversation

codekansas
Copy link
Contributor

Fix for #815

Hmm... Turns out there's a lot of repeated things that are kind of a mess to maintain. I was thinking that a good way to unify the "text-heavy" parts of this project would be to use something like Jekyll, so that the texts of like the "about" parts could be written first in Markdown then built to HTML, which would be much cleaner than just writing everything in HTML (as it currently stands). For example, disclaimers and stuff that is used frequently throughout multiple apps could be written once, so that if they have to be updated somewhere down the line it is cleaner / safer than running some complicated grep. For example, you can put peoples' emails in a yaml file so that they can be updated / referenced more easily...

The Jekyll stuff wouldn't add very much technical complexity / likelihood of breaking things, since it's just a static markdown renderer (i.e. renders to HTML templates). Design would be something like:

Add a subdirectory in the project devoted to static includes (i.e. jekyll-templates/) with two subdirectories, src/ and generated/. Put all the Jekyll text in the src/ directory. Add the generated/ directory as a Django template location. When Jekyll stuff gets changed, run the command

jekyll build --source src/ --destination generated/

Anyway... Just an idea. I didn't do it in this commit because refactoring all the current HTML to Markdown seemed like it would take a long time. But anyway here's the command I used for this:

grep -rl 'https://www.continuum.io/content/tj-alumbaugh' . | xargs sed -i "" 's/https:\/\/www\.continuum\.io\/content\/tj\-alumbaugh/https:\/\/github.com\/talumbau/g'

@hdoupe
Copy link
Collaborator

hdoupe commented Feb 1, 2018

@codekansas Thanks for taking care of this.

RE using Jekyll: I'm not familiar with it, but it seems like a neat tool. The html parts of the site (and the front-end in general) have needed some attention for awhile. Would you mind opening a separate issue re-stating why we should use jekyll and any other front-end changes that fit in with that?

Give me some time to look at this PR, and we'll just merge it within the current html framework.

@codekansas codekansas mentioned this pull request Feb 1, 2018
@hdoupe
Copy link
Collaborator

hdoupe commented Feb 2, 2018

Thanks for the thorough update @codekansas. I see what you mean about having a bunch of duplicated text.

@hdoupe hdoupe merged commit 3e4e0ee into ospc-org:master Feb 2, 2018
@codekansas codekansas deleted the fix branch February 3, 2018 04:39
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.

None yet

2 participants