Skip to content
This repository has been archived by the owner on Sep 15, 2022. It is now read-only.

[Posts] Simplify expected blog post markdown #6

Closed
kptdobe opened this issue Dec 5, 2019 · 1 comment
Closed

[Posts] Simplify expected blog post markdown #6

kptdobe opened this issue Dec 5, 2019 · 1 comment

Comments

@kptdobe
Copy link
Contributor

kptdobe commented Dec 5, 2019

https://github.com/davidnuescheler/theblog/blob/alexonedrive/content/posts/creating-adobe-experience-platform-pipeline-with-kafka.md starts being the "reference" markdown.

The current style implementation requires the md file to start with:

  • a title
  • a thematic break
  • an image
  • a thematic break
  • the "author block"
  • a thematic break
  • the blog post content

All those thematic breaks are only here to properly style the fullscreen hero image and to differentiate the author section.
This requires the author to know those requirements and will be leading to a lot of rendering errors (oups i forgot a thematic break somewhere...).

TODO 1: remove the first TB from the reference md and rewrap the dom with required divs. This should be doable with adobe/helix-pipeline#516

But this does not solve the "what if the author does not have a hero image" or "he/she/they forgot to add the author section"... our code has to have a strong resilience to author mistakes. This would be doable only with code...

TODO 2: make sure the layout does not break for basic author mistakes or use cases we forgot.

@kptdobe kptdobe changed the title Simplify expected blog post markdown [Posts] Simplify expected blog post markdown Dec 18, 2019
@rofe
Copy link
Contributor

rofe commented Aug 7, 2020

I think we can close this now as the current document structure is documented and authors trained.

@rofe rofe closed this as completed Aug 7, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants