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

Move Author bios to Meta data #1413

Merged
merged 2 commits into from
Nov 4, 2020
Merged

Move Author bios to Meta data #1413

merged 2 commits into from
Nov 4, 2020

Conversation

tunetheweb
Copy link
Member

Since we merged #1104 which had a prettier re-org this is easier.

A few issues/reasons not to do this:

  1. Quotes still need unescaping which looks a little funny.
  2. Some people Authored multiple chapters (e.g. Paul) so need two bios.
  3. Can't easily reuse this data if we ever implement contributor bio pages as mentioned in Contributor profile pages #1195
  4. Requires another bulk update to all the chapters 😞

Other than that, seems like a good thing to do.

@tunetheweb tunetheweb added the development Building the Almanac tech stack label Nov 4, 2020
@tunetheweb tunetheweb added this to the 2020 Platform Development milestone Nov 4, 2020
@tunetheweb tunetheweb marked this pull request as draft November 4, 2020 15:43
@tunetheweb
Copy link
Member Author

Will convert rest of chapters if happy to continue with this. So just a Draft PR to allow easy review until I do that.

@tunetheweb tunetheweb changed the title Move Author bios to HTML Move Author bios to Meta data Nov 4, 2020
@rviscomi
Copy link
Member

rviscomi commented Nov 4, 2020

Some people Authored multiple chapters (e.g. Paul) so need two bios.

Should be rare. Not sure if we have that problem this year. One thing to watch out for is consistency across chapters translated by different people. One cool thing would be some middleware that can support something like "bio: see chapter X" and the author's bio in chapter X gets reused.

Can't easily reuse this data if we ever implement contributor bio pages as mentioned in #1195

I think a middleware solution could be useful here. During the chapter generation script, extract the metadata and generate a new metadata file with all author info. Or if we go the bio page route maybe we have to maintain a standalone contributor bio metadata file anyway, and not couple it with the md at all.

Requires another bulk update to all the chapters 😞

In all, this looks like a good change, so I support moving forward with the rest of the chapters. Greatly appreciate your efforts ❤️

@tunetheweb tunetheweb marked this pull request as ready for review November 4, 2020 17:48
@tunetheweb tunetheweb merged commit 112f566 into main Nov 4, 2020
@tunetheweb tunetheweb deleted the author_bios_metadata branch November 4, 2020 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development Building the Almanac tech stack
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants