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

Code samples should be stored in a repo #3203

Closed
rmloveland opened this issue May 30, 2018 · 6 comments
Closed

Code samples should be stored in a repo #3203

rmloveland opened this issue May 30, 2018 · 6 comments
Assignees
Milestone

Comments

@rmloveland
Copy link
Contributor

... and pulled into the site at build time.

This would allow us to make sure that the samples are tested via CI, so users always get working code.

There are probably many Jekyll plugins that allow for this type of functionality. I found a few with some lazy Googling:

  • jekyll-code-example-tag - stores the code samples in local dirs, but we could write some magic to do a git clone and pop in some symlinks or something
  • jekyll-github-sample - this appears to run client-side, which is (IMO) less ideal since now we'd have two problems. But it's an example of something that exists.

Filing this issue based on a convo just now with @BramGruneir

@jseldess
Copy link
Contributor

Also just chatted with @BramGruneir about this a bit. I'm not sure it's necessary to store these in a separate repo. They're currently all separate include files, so we could already run them against proper docker images for each driver and ORM. For 2.2, let's definitely make it a docs project to automate the testing of our code samples, and as part of that, we can figure out if they should be a separate repo or not.

@jseldess jseldess added this to the 2.2 milestone May 30, 2018
@jseldess
Copy link
Contributor

Should be considered as part of #182.

@jseldess
Copy link
Contributor

jseldess commented Nov 9, 2018

Part of #3943.

@jseldess jseldess modified the milestones: 2.2, 19.1 Feb 25, 2019
@jseldess
Copy link
Contributor

This isn't going to happen in the 19.1 timeframe. Moving to 19.2 for prioritization.

@jseldess
Copy link
Contributor

jseldess commented Oct 1, 2019

Moving this to 20.1 timeframe.

@jseldess
Copy link
Contributor

jseldess commented Apr 3, 2020

Closing in favor of #7066.

@jseldess jseldess closed this as completed Apr 3, 2020
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