-
Notifications
You must be signed in to change notification settings - Fork 10
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
feat: add local env setup documentation #199
feat: add local env setup documentation #199
Conversation
docs/source/index.rst
Outdated
@@ -80,6 +80,7 @@ Some quick links: | |||
:hidden: | |||
|
|||
operations/index.rst | |||
operations/getting-started.rst |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AlexandrePicosson In which category would you see it? My understanding was the section "Substra examples" and "Substrafl examples" were more deep dive into the use of the librairies. Should it be top-level?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we could add a category targeted more at developers @adarbier what is your opinion on this ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes I think it would be great to have a "Contributing to Substra" section with:
- High level guidelines for contributing
- How to locally run the substra stack (this doc basically)
- Maybe other sections? (build the doc, run the tests, submit a PR, etc.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For this PR I can create the category and move this page but I think the other points (including the front page of "Contributing to Substra") should be handled separately
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for the PR, the Sphinx features uses is perfect :D
@RomainGoussault do we want this page as the first one of the doc ? (which mean that when clicking on "next" from welcome page, we directly have this one)
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
6749038
to
6f8eb20
Compare
Thanks for the PR @guilhem-barthes. I feel this is weird to have this page at the top. I think once we have more things to put in a "Contributing Substra" section we could have one but for now I would keep the page in "Deploying Substra". |
Other general comment, it is not clear to me how the "Deploying Substra" page relates to the "How-to" pages. |
Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR, that is much clearer now :)
This PR addresses changes made after PR #193 has been merged