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.

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

Conversation

guilhem-barthes
Copy link
Contributor

This PR addresses changes made after PR #193 has been merged

@@ -80,6 +80,7 @@ Some quick links:
:hidden:

operations/index.rst
operations/getting-started.rst
Copy link
Contributor Author

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?

Copy link
Member

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 ?

Copy link
Contributor

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.)

Copy link
Contributor Author

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

@guilhem-barthes guilhem-barthes marked this pull request as ready for review October 6, 2022 13:56
Copy link
Member

@ThibaultFy ThibaultFy left a 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)

docs/source/contributing/getting-started.rst Outdated Show resolved Hide resolved
docs/source/contributing/getting-started.rst Outdated Show resolved Hide resolved
docs/source/contributing/getting-started.rst Outdated Show resolved Hide resolved
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>
@guilhem-barthes guilhem-barthes force-pushed the feature/add-local-env-setup-documentation branch from 6749038 to 6f8eb20 Compare November 18, 2022 16:22
@RomainGoussault
Copy link
Contributor

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)

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".

@RomainGoussault
Copy link
Contributor

Other general comment, it is not clear to me how the "Deploying Substra" page relates to the "How-to" pages.
Should I start by the "Deploying Substra" page which will give a general overview and then move to the how to guides?

Signed-off-by: Guilhem Barthes <guilhem.barthes@owkin.com>
Copy link
Contributor

@RomainGoussault RomainGoussault left a 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 :)

Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@guilhem-barthes guilhem-barthes merged commit cebe97f into main Nov 24, 2022
@guilhem-barthes guilhem-barthes deleted the feature/add-local-env-setup-documentation branch November 24, 2022 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants