Substra / substra-documentation

Documentation of the Substra software
https://docs.substra.org/
Apache License 2.0
21 stars 10 forks source link

feat: add remote doc examples #357

Closed ThibaultFy closed 1 year ago

ThibaultFy commented 1 year ago

Description

Add the files to make the examples runable by run-ci.py. ✅ ci: https://github.com/owkin/substra-ci/actions/runs/6199350859/job/16831707968

closes FL-994

Need PR on three orgs skaffold profile (cf https://linear.app/owkin/issue/FL-1208/add-skaffold-profile-to-launch-three-organizations) to be merged before

Companion

linear[bot] commented 1 year ago
FL-994 Add documentation examples in remote mode to Substra CI

Add the documentation examples to the nightly run from the substra-ci repository. A script already exists in substra-ci: [https://github.com/owkin/substra-ci/blob/main/run-documentation-examples.py](https://github.com/owkin/substra-ci/blob/main/run-documentation-examples.py) to run the examples. See [https://github.com/owkin/substra-ci/blob/main/.github/workflows/documentation-examples.yml](https://github.com/owkin/substra-ci/blob/main/.github/workflows/documentation-examples.yml) to see how they are run in local modes. The objective is to add the run of this script in the run-ci.py. To do that, we need to set the right ENV VAR to configure the client examples. Add a section to the slack message posted during the nightly. Some examples might fail as the don't wait for the end of CP in remote. Inspiration from MNIST example might be usefull [https://github.com/Substra/substra-documentation/blob/c08a5c82af922da5e69cac06f0f5709d86197441/substrafl_examples/get_started/run_mnist_torch.py#L479C2-L479C2](https://github.com/Substra/substra-documentation/blob/c08a5c82af922da5e69cac06f0f5709d86197441/substrafl_examples/get_started/run_mnist_torch.py#L479C2-L479C2) Also, we might want to add an argument to the GH bot Owlfred to be able to launch the examples: [https://github.com/owkin/substra-gh-bot](https://github.com/owkin/substra-gh-bot) but the current bot build is failing. So blocked by [FL-1036](https://linear.app/owkin/issue/FL-1036/fix-substra-gh-bot-deployment) for this specific part on the GH bot.