buildpacks icon indicating copy to clipboard operation
buildpacks copied to clipboard

Add Ruby tutorial

Open schneems opened this issue 1 year ago • 2 comments

Built from a rundoc document in development. PR is https://github.com/zombocom/rundoc/pull/41. Please leave feedback and suggestions at https://github.com/zombocom/rundoc/pull/41 as that is the source document. Once we're happy with that, I can re-write the node buildpack tutorial to use rundoc and add other languages.

schneems avatar Apr 29 '24 16:04 schneems

Sorry, should have opened this as a draft before. I've fixed the major issues, I believe it's ready for review now.

schneems avatar Apr 29 '24 18:04 schneems

@schneems I meant to ask, why does the doc live in https://github.com/zombocom/rundoc/pull/41?

colincasey avatar May 02 '24 18:05 colincasey

@schneems I meant to ask, why does the doc live in https://github.com/zombocom/rundoc/pull/41?

That was me trying to take a smaller step. The plan would be to port it over. I (was) trying to do this incrementally so that this repo wouldn't have a dependency on rundoc (figured I would face less resistance). The idea being that it's really no different than a hand-written tutorial at this point of merge. To iterate on the doc directly while I iron out the details of how I actually want it to look seperately.

However: I think that's added to the confusion. I think we can always choose to drop rundoc as a dependency and just use the source at any time, so it's a two-way-door kind of decision.

I want to take this further and automate the tutorial generation.

Tutorial generation on GHA Sketch

Commit the raw rundoc files to source here. Set GitHub Actions (GHA) so that it can generate rundoc documents. Have it build the docs on a weekly timer, or we could also trigger it manually or based on other events (like publishing a new builder).

It would:

  • Build the docs (which also act as a direwolf-like integration test)
  • If successful open a PR to update the docs in this repo
  • If failed: let us know somehow. Possibly open up an issue and tagging heroku/languages.

I would LOVE if something like that existed. I think it would help two fold:

  • Increase the accuracy and validity of our docs.
  • Turn our docs into a source quality control check (benefit) instead of burden (cost).

schneems avatar Jun 11 '24 18:06 schneems

Closing in favor of https://github.com/heroku/buildpacks/pull/28 and https://github.com/heroku/buildpacks/pull/27

schneems avatar Jul 22 '24 19:07 schneems