[docs] cookbook section with initial cookbooks (rust)

[zmitchell]

original issue

The documentation site currently has one example of how to package software with flox. We have a wealth of examples in the flox-examples repo. We should link to those examples as a stop-gap for writing detailed guides for each language or framework.

We can write more detailed guides and tutorials in the future, but in the mean time we can leverage existing examples.

[robinbrantley]

Just a heads up - those examples should probs be checked again to be sure they still work as they've been hidden awhile and there have been several changes to flox since.

[garbas]

We need to test those examples on a daily basis to know when they stop working. I wouldn't be comfortable publishing them before that.

[ysndr]

what exactly is the state/scope of this?

I guess state would be blocked, but we don't have an issue for testing examples.

@garbas how do you think should we do the testing? a ci workflow in each example, pulling flox prerelease and running through the example steps once per day?

[garbas]

We generally should test all our console snippets and or anything we tell people to try. I proposed to do this some time ago when I was working on documentation more closely, but I we had bigger thing to take care of at the time.

I would suggest to use https://github.com/OceanSprint/tesh as a runner and annotate our code example to be ran as often as we can. Once a day would be a nice middle ground.

[ysndr]

👍🏼

OceanSprint/tesh looks interesting, abandoned, but interesting

[stahnma]

I'm not sure I understand this ticket or how to complete it. We went from having a link to flox-examples to needing a testing framework for documentation and examples. Those both seem important, but not the same issue. Can we split them up and conquer them?

[stahnma]

I'm not sure I understand this ticket or how to complete it. We went from having a link to flox-examples to needing a testing framework for documentation and examples. Those both seem important, but not the same issue. Can we split them up and conquer them?

[stahnma]

I'm not sure I understand this ticket or how to complete it. We went from having a link to flox-examples to needing a testing framework for documentation and examples. Those both seem important, but not the same issue. Can we split them up and conquer them?

[ysndr]

I understood @garbas comment as "missing testing blocks adding (potentially broken) examples to the the docs".

• we do need a separate issue for such tests
• I don't think that has to be blocking, is the priority having (more) confidence that all examples work or that we have examples linked at all?

[ghudgins]

cookbook ideas:

• flox/floxdocs#8
• node
• go
• python
• rust
• ruby

[zmitchell]

I would structure this as:

• Cookbook
  • Languages and frameworks
    • Node
    • Go
    • etc
  • other pages

[zmitchell]

"other pages" could include the "known issues" page as well, but I could see a case to be made that it belongs at the topic level