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.

Sign up for GitHub

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

feat: add local env setup documentation #199

Merged
merged 15 commits into from
Nov 24, 2022
Merged

feat: add local env setup documentation #199

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
7052c71
doc: Add first iteration of getting started
guilhem-barthes Sep 29, 2022
f4b3ea7
docs: Add troubleshooting section
guilhem-barthes Sep 30, 2022
4fe874f
docs: Move hardware caution box
guilhem-barthes Sep 30, 2022
94f0895
docs: Improve steps about k3-create.sh
guilhem-barthes Sep 30, 2022
f669ff4
fix: Fix typo
guilhem-barthes Sep 30, 2022
0cc768d
fix: Apply reviews comments
guilhem-barthes Sep 30, 2022
cb17866
fix: Apply review comments
guilhem-barthes Oct 3, 2022
e357d22
fix: Apply feedback
guilhem-barthes Oct 4, 2022
a269b1a
fix: Indent
guilhem-barthes Oct 4, 2022
05d4853
fix: Apply feedback about Skaffold 1.31.0
guilhem-barthes Oct 5, 2022
6655134
refactor: move getting-started to new contributing category
guilhem-barthes Oct 7, 2022
6f8eb20
docs: update getting started doc page
guilhem-barthes Nov 18, 2022
408c4f3
docs: apply feedback
guilhem-barthes Nov 23, 2022
2047326
blanck
ThibaultFy Nov 24, 2022
96e0569
blanck
ThibaultFy Nov 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: Move hardware caution box 
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
  • Loading branch information
@guilhem-barthes
guilhem-barthes committed Nov 18, 2022
commit 4fe874fa3fc2a566db1a89610c6692f206e911d7
6 changes: 3 additions & 3 deletions docs/source/operations/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ The following table indicates the resources needed to run the Substra stack loca
.. caution::
Choose wisely the parameters passed to Kubernetes as it might try to use all the allocated resources without regards for your system.

.. caution::
Choose wisely the parameters passed to Kubernetes as it might try to use all the allocated resources without regards for your system.

Software
--------

Expand All @@ -55,9 +58,6 @@ Software
* `Helm 3 <https://helm.sh/>`_ (>= 3.7.0)
* `nodeJS <https://nodejs.org/>`_ (== 16.13.0)

.. attention::
Please be cautious with the parameters passed to Kubernetes as it might try to use all the allocated resources without regards for your system.

Instructions for Mac
^^^^^^^^^^^^^^^^^^^^

Expand Down