Engineering 🧰 Migrate to github.io

Ismael-KG commented 2 years ago

Title

Migrate to github.io

Elevator Pitch

Following #37 and #31 , migrate stories to https://ismael-kg.github.io/A-History-of-Research-Ethics/ using the new stories template.

Justification

This will track changes to stories in light of @yochannah's very helpful yaml code, which is now here.

Skills

Skill	Rationale
Copying & Pasting, and knowing the stories	There is still a chance that some stories to not adhere perfectly to the new yaml-based template, so an eye must be kept on how they integrate
Coding & Bug-Fixing	For when errors do appear

Tasks

[x] Migrate Stories
[x] Review first migrations (see comment below)
[x] Review all migrations of Stories
[x] Migrate Stories in Progress
[x] Revisit migrated Stories and relocate to Works_In_Progress where necessary
[ ] Migrate Published but needs Improving
[ ] Edit the template to include instructions (remember to explain that questions/errors can be discussed in PRs, rather than committed directly).
[x] Add "author element" to yaml (as per comment).
[ ] Edit story title structure to include mention of "(work in progress)" as per other comment — one for @yochannah's magicologicus.
[x] Create issues for Stories, so potential contributors can make suggestions

Ismael-KG commented 2 years ago

These four early migrations need updating:

Ismael-KG commented 2 years ago

@yochannah - just a detail, as I had resigned to this method for GitHub anyway: BCE stories appear in the wrong order:

This is genuinely fine, but if you know a magic trick to make BCE years appear in the right order, that would be great!

yochannah commented 2 years ago

@Ismael-KG like this? #41

Ismael-KG commented 2 years ago

@yochannah do you know how to add a new element (author) to the yaml? Under date and category, same format, it would be great to have a line for "author(s)".

There will then be a question as to whether:

we add different lines for each contribution type; or
whether the new element is "contributor(s)" and each contributor's name is followed by their contribution type in brackets; or the why-not-both option
whether there is one line for author(s) and another for contributor(s).

Ismael-KG commented 2 years ago

Oh, I know! @yochannah , story titles should end with "(work in progress)" if that is the case!

The reason I haven't migrated most stories is I am not sure what to do with "incomplete" ones. I think a flag like this (by default, include "(work in progress)") would be great! This way, readers know whether to expect much more content in stories >.<

yochannah commented 2 years ago

wip: true ?

On Fri, Dec 10, 2021 at 8:47 AM Ismael-KG @.***> wrote:

Oh, I know! @yochannah https://github.com/yochannah , story titles should end with "(work in progress)" if that is the case!

The reason I haven't migrated most stories is I am not sure what to do with "incomplete" ones. I think a flag like this (by default, include "(work in progress)") would be great! This way, readers know whether to expect much more content in stories >.<

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Ismael-KG/A-History-of-Research-Ethics/issues/40#issuecomment-990742972, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACGXRDQTRAK3ATM76UCGB6DUQG5CBANCNFSM5JRXG5SQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

Ismael-KG commented 2 years ago

I suppose so! Like this?

---
layout: story
title: "title"
wip: true or false
historical-date:
  title: "year, explanation or as per"
  bce: true or false
  year: YYYY
  source: link to the source that justifies the choice of date
  author: surname(s) of authors of the linked source
  source-date: year
category: opening-knowledge, ldf, improving-research or research-tragedies
tags: ["Bioethics", "How We Do Things","Science Influencers","What We Value"]
media:
  source: link to the site where the image is; delete line if there is no image
  caption: "ALT text and acknowledgement of source"; delete line if there is no image
read-more: link to the story's pertinent document/article/book, if there is one; otherwise, delete line
intro: text
---
### The Story
<!-- Paste the story into this line! Remember the old adage: a line is a paragraph, and a blank line must be placed between paragraphs. -->

How about the author? Adding a line for "Author(s)" (like "category") didn't work.

yochannah commented 2 years ago

add the author line, I'll need to add some logic into the display template to output it, that's all

On Fri, Dec 10, 2021 at 9:16 AM Ismael-KG @.***> wrote:

I suppose so! Like this?

layout: story title: "title" wip: true or false historical-date: title: "year, explanation or as per" bce: true or false year: YYYY source: link to the source that justifies the choice of date author: surname(s) of authors of the linked source source-date: year category: opening-knowledge, ldf, improving-research or research-tragedies tags: ["Bioethics", "How We Do Things","Science Influencers","What We Value"] media: source: link to the site where the image is; delete line if there is no image caption: "ALT text and acknowledgement of source"; delete line if there is no image read-more: link to the story's pertinent document/article/book, if there is one; otherwise, delete line intro: text

The Story

How about the author? Adding a line for "Author(s)" (like "category") didn't work.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Ismael-KG/A-History-of-Research-Ethics/issues/40#issuecomment-990763507, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACGXRDT23UEZN5IQLTT5E4DUQHAQLANCNFSM5JRXG5SQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

Ismael-KG commented 2 years ago

Amazing, added wip, authors and contributors:

---
layout: story
title: "title"
wip: true or false
historical-date:
  title: "year, explanation or as per"
  bce: true or false
  year: YYYY
  source: link to the source that justifies the choice of date
  author: surname(s) of authors of the linked source
  source-date: year
category: opening-knowledge, ldf, improving-research or research-tragedies
author(s): full name(s)
contributor(s): full name(s) and [contribution type](https://github.com/Ismael-KG/A-History-of-Research-Ethics/blob/main/Protocols.md#Protocol-3-Contribution-Types) between brackets
tags: ["Bioethics", "How We Do Things","Science Influencers","What We Value"]
media:
  source: link to the site where the image is; delete line if there is no image
  caption: "ALT text and acknowledgement of source"; delete line if there is no image
read-more: link to the story's pertinent document/article/book, if there is one; otherwise, delete line
intro: text
---
### The Story
<!-- Paste the story into this line! Remember the old adage: a line is a paragraph, and a blank line must be placed between paragraphs. -->

Of course, the contributor line can disappear when necessary, and I won't be putting my name down as author until others write stuff. My name appears in enough places on this already!

yochannah commented 2 years ago

ah, so I just upset Jekyll by trying to update the template to support author(s) - could we make it authors instead?

yochannah commented 2 years ago

... oh goodie, I note it's not really implemented yet. I will use authors.

Ismael-KG commented 2 years ago

@yochannah, is this how the yaml should look?

---
layout: story
title: "title"
wip: true or false
  issue: 
historical-date:
  title: "year, explanation or as per"
  bce: true or false
  year: YYYY
  source: link to the source that justifies the choice of date
  author: surname(s) of authors of the linked source
  source-date: year
category: opening-knowledge, ldf, improving-research or research-tragedies
authors: full name(s)
contributors: full name(s) and [contribution type](https://github.com/Ismael-KG/A-History-of-Research-Ethics/blob/main/Protocols.md#Protocol-3-Contribution-Types) between brackets
tags: ["Bioethics", "How We Do Things","Science Influencers","What We Value"]
media:
  source: link to the site where the image is; delete line if there is no image
  caption: "ALT text and acknowledgement of source"; delete line if there is no image
read-more: link to the story's pertinent document/article/book, if there is one; otherwise, delete line
intro: text
---
### The Story
<!-- Paste the story into this line! Remember the old adage: a line is a paragraph, and a blank line must be placed between paragraphs. -->

yochannah commented 2 years ago

For now it looks good! I see nothing that frightens me.

On Wed, 15 Dec 2021, 19:44 Ismael-KG, @.***> wrote:

@yochannah https://github.com/yochannah, is this how the yaml should look?

layout: story title: "title" wip: true or false issue: historical-date: title: "year, explanation or as per" bce: true or false year: YYYY source: link to the source that justifies the choice of date author: surname(s) of authors of the linked source source-date: year category: opening-knowledge, ldf, improving-research or research-tragedies authors: full name(s) contributors: full name(s) and contribution type between brackets tags: ["Bioethics", "How We Do Things","Science Influencers","What We Value"] media: source: link to the site where the image is; delete line if there is no image caption: "ALT text and acknowledgement of source"; delete line if there is no image read-more: link to the story's pertinent document/article/book, if there is one; otherwise, delete line intro: text

The Story

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Ismael-KG/A-History-of-Research-Ethics/issues/40#issuecomment-995159049, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACGXRDTUZVOKSPJNPUMIUS3URDVZ3ANCNFSM5JRXG5SQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

Ismael-KG commented 2 years ago

@yochannah – new thought on wip:

Can it have three values? For each, the following would happen:

wip: true

yaml shows everything + "If you would like to suggest improvements to this story, please check the protocols for contributors and leave a comment the following GitHub issue: [linked issue number]!"

wip: false

yaml shows title, year, intro + "This story is still a work in progress. If you would like to help write it or know some useful resources that should be referenced, please share some thoughts in the following GitHub issue: [linked issue number]!"

wip: review

yaml shows title, year, intro + "This story is almost ready to be published! We would be really grateful if you took a moment to review the current draft, which is here: https://hackmd.io/VW6SvaOYTemXnOd4SMcC4Q?both."

yochannah commented 2 years ago

trinary sounds great!

KairoiAI / An_Incomplete_History_of_Research_Ethics