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

Jump to bottom

docs(*:skip) Update Docker documentation #3722

Merged
merged 27 commits into from
Aug 21, 2024
Merged

docs(*:skip) Update Docker documentation #3722

merged 27 commits into from
Aug 21, 2024

Conversation

Robert-Steiner
Copy link
Member

@Robert-Steiner Robert-Steiner commented Jul 5, 2024 •
edited
Loading

Issue

Description

  • Rework Docker documentation.
  • Create a new quickstart with docker page.
  • Move advanced docker options to sub pages.

Related issues/PRs

Proposal

Explanation

Checklist

  • Implement proposed change
  • Write tests
  • Update documentation
  • Make CI checks pass
  • Ping maintainers on Slack (channel #contributions)

Any other comments?

@Robert-Steiner Robert-Steiner self-assigned this Jul 5, 2024
@Robert-Steiner Robert-Steiner force-pushed the doc/update-supernode-docker-image branch 7 times, most recently from 9ccd11f to dbb94bb Compare July 17, 2024 13:22
chongshenng
chongshenng requested changes Jul 18, 2024
View reviewed changes
Copy link
Contributor

@chongshenng chongshenng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Robert-Steiner, I've reviewed mainly the Quickstart and have suggested some changes. About including dependencies in the Dockerfile, I prefer if we can show how to use pyproject.toml to reduce copy-pasting dependencies across files. Can you also check the flwr run execution? I think it's missing some arguments to run on the Docker SuperExec/SuperLink.

doc/source/docker/index.rst Outdated Show resolved Hide resolved
doc/source/docker/persist-state.rst Outdated Show resolved Hide resolved
doc/source/docker/persist-state.rst Outdated Show resolved Hide resolved
doc/source/docker/persist-state.rst Outdated Show resolved Hide resolved
doc/source/docker/persist-state.rst Outdated Show resolved Hide resolved
doc/source/docker/quickstart.rst Outdated Show resolved Hide resolved
doc/source/docker/quickstart.rst Outdated Show resolved Hide resolved
doc/source/docker/quickstart.rst Outdated Show resolved Hide resolved
doc/source/docker/quickstart.rst Outdated Show resolved Hide resolved
doc/source/docker/quickstart.rst Outdated Show resolved Hide resolved
@Robert-Steiner Robert-Steiner force-pushed the doc/update-supernode-docker-image branch from 4a0bab1 to cae146e Compare July 19, 2024 09:43
@Robert-Steiner Robert-Steiner force-pushed the doc/update-supernode-docker-image branch 5 times, most recently from bd7032e to ccf511b Compare July 24, 2024 13:53
@Robert-Steiner Robert-Steiner requested a review from Moep90 July 24, 2024 14:46
chongshenng
chongshenng previously requested changes Jul 25, 2024
View reviewed changes
Copy link
Contributor

@chongshenng chongshenng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Robert-Steiner for the updates! A few more minor suggestions on the other pages.

doc/source/contributor-how-to-build-docker-images.rst Outdated Show resolved Hide resolved
doc/source/contributor-how-to-build-docker-images.rst Outdated Show resolved Hide resolved
doc/source/contributor-how-to-build-docker-images.rst Outdated Show resolved Hide resolved
doc/source/contributor-how-to-build-docker-images.rst Outdated Show resolved Hide resolved
doc/source/contributor-how-to-build-docker-images.rst Outdated Show resolved Hide resolved
doc/source/docker/tls.rst Outdated Show resolved Hide resolved
doc/source/docker/tls.rst Outdated Show resolved Hide resolved
doc/source/docker/tls.rst Outdated Show resolved Hide resolved
doc/source/docker/tls.rst Outdated Show resolved Hide resolved
doc/source/docker/tls.rst Outdated Show resolved Hide resolved
@Robert-Steiner Robert-Steiner force-pushed the doc/update-supernode-docker-image branch 2 times, most recently from 157f15a to 9135310 Compare July 25, 2024 12:30
@Robert-Steiner
Copy link
Member Author

Thanks @Robert-Steiner for the updates! A few more minor suggestions on the other pages.

@chongshenng, thanks for the great feedback! I tried to address all the comments. Let me know in case I missed one. Regarding renaming current_flwr_version to stable_flwr_version. I synced with @charlesbvll, and he is going to create a new separate PR because the variable is not only used in the docker docs. I will update this PR once it has been merged.

@Robert-Steiner Robert-Steiner force-pushed the doc/update-supernode-docker-image branch 2 times, most recently from e318719 to 3771a89 Compare July 26, 2024 09:59
@Robert-Steiner Robert-Steiner changed the title docs(*:skip) Update SuperNode docker example docs(*:skip) Rework Docker documentation Jul 26, 2024
@Robert-Steiner Robert-Steiner marked this pull request as ready for review July 26, 2024 10:06
@Robert-Steiner Robert-Steiner changed the title docs(*:skip) Rework Docker documentation docs(*:skip) Update Docker documentation Jul 26, 2024
@Robert-Steiner Robert-Steiner mentioned this pull request Jul 26, 2024
Merged
5 tasks
Robert-Steiner and others added 16 commits August 12, 2024 11:31
@Robert-Steiner
small improvements
3210850 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
Make the creation of the dockerfiles simpler
0c1ee7f 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
Make the flwr new command shorter
748ece1 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
fix inline literal
9d535e7 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
fmt
cafc3c2 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
remove sphinx-substitution-extensions from deps
481d872 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
update to 1.10.0.dev20240722
4e77d15 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
show how to add the FAB to the supernode image
753181c 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
fix broken formatting
12e9687 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
add how to track the superexec logs
d8599af 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
update to 1.10.0
7ab943a 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner @chongshenng
Apply suggestions from code review
9d9029b 
Co-authored-by: Chong Shen Ng <chong.shen@flower.ai>
@Robert-Steiner
address review comments
353cfe1 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
small improvements
9aaf531 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner @chongshenng
Apply suggestions from code review
2c069e0 
Co-authored-by: Chong Shen Ng <chong.shen@flower.ai>
@Robert-Steiner
rename to stable_flwr_version
98bcc4e 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner Robert-Steiner force-pushed the doc/update-supernode-docker-image branch from e011cdf to 1040123 Compare August 12, 2024 09:31
@Robert-Steiner
fix minor errors
ff0846e 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner Robert-Steiner force-pushed the doc/update-supernode-docker-image branch from 1040123 to ff0846e Compare August 12, 2024 09:32
Robert-Steiner and others added 3 commits August 20, 2024 11:24
@Robert-Steiner @danieljanes
Update doc/source/contributor-how-to-build-docker-images.rst
f236888 
Co-authored-by: Daniel J. Beutel <daniel@flower.ai>
@Robert-Steiner
use imperative form
eb425be 
Signed-off-by: Robert Steiner <robert@flower.ai>
@Robert-Steiner
Merge branch 'main' into doc/update-supernode-docker-image
d38aca1
tanertopal
tanertopal approved these changes Aug 21, 2024
View reviewed changes
Copy link
Member

@tanertopal tanertopal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! Great work!

@tanertopal tanertopal dismissed chongshenng’s stale review August 21, 2024 19:21

Changes are added.

@tanertopal tanertopal enabled auto-merge (squash) August 21, 2024 19:21
@tanertopal tanertopal merged commit abde02e into main Aug 21, 2024
33 checks passed
@tanertopal tanertopal deleted the doc/update-supernode-docker-image branch August 21, 2024 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danieljanes danieljanes danieljanes left review comments

@tanertopal tanertopal tanertopal approved these changes

@Moep90 Moep90 Awaiting requested review from Moep90

@chongshenng chongshenng Awaiting requested review from chongshenng

Assignees

@Robert-Steiner Robert-Steiner

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Robert-Steiner @tanertopal @danieljanes @chongshenng