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

Add Elixir Version Metadata to Posts #220

Open
kinson opened this issue Jul 24, 2023 · 2 comments
Open

Add Elixir Version Metadata to Posts #220

kinson opened this issue Jul 24, 2023 · 2 comments

Comments

@kinson
Copy link
Contributor

kinson commented Jul 24, 2023

Also, what are your thoughts on updating the elixirschool readme section Posting an Article to nudge authors to specify the versions of Elixir, Phoenix, LiveView, etc. used in their code examples.

Another approach could be to extend the article metadata with an optional :versions field e.g.

%{
  author: "Author Name",
  author_link: "https://github.com/author_github_account",
  tags: ["phoenix", "liveview"],
  versions: [{:phoenix, "~> 1.7.6"}, {:phoenix_live_view, "~> 0.19.0"}]
  date: ~D[YYYY-MM-DD],
  title: "Full Article Title",
  excerpt: """
  Article short preview text
  """
}
--- 

Originally posted by @codeanpeace in #216 (comment)

@kinson
Copy link
Contributor Author

kinson commented Jul 24, 2023

@codeanpeace I think that's a valuable suggestion. I think as long as it's optional (though encouraged that would be good metadata to have and display). Maybe we could add a more specific key though to not be confused with lesson or blog version? Something like elixir_and_deps_versions? What do you think?

@codeanpeace
Copy link
Contributor

Yeah, agreed that it should be optional but encouraged.

That's a good point regarding naming confusion. The other potentially confusing thing for authors is that elixir and dependencies are specified separately in a standard mix.exs. For simplicity's sake, combining them as elixir_and_deps_versions or even just elixir_and_deps makes sense but we should definitely highlight that in the readme.

It also occurs to me that this metadata could make it possible to incorporate LiveBook functionality one day, which would be very cool.

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

No branches or pull requests

2 participants