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

docs(framework) Update how to upgrade to Flower 1.13 documentation #4533

Merged
merged 30 commits into from
Nov 20, 2024

Conversation

dstripelis
Copy link
Contributor

  • Added server and client app examples for versions 1.11+.
  • Moved sentence highlighting to latest flower versions.

…g examples for Flower versions 1.11 and above.
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.

@dstripelis Thanks for starting this update! There're 2 large parts that need to be updated:

doc/source/how-to-upgrade-to-flower-next.rst Outdated Show resolved Hide resolved
doc/source/how-to-upgrade-to-flower-next.rst Outdated Show resolved Hide resolved
doc/source/how-to-upgrade-to-flower-next.rst Outdated Show resolved Hide resolved
doc/source/how-to-upgrade-to-flower-next.rst Outdated Show resolved Hide resolved
doc/source/how-to-upgrade-to-flower-next.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@jafermarq jafermarq left a comment

Choose a reason for hiding this comment

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

Should we also remove the requirements.txt comment at the top of the document as well as the "Using Poetry" section? Although people can choose to use them, neither of those will work in a deployment setup that relies on the FAB-delivery mechanism. Because of this I think it's better to remove them.

Another point, I'm wondering if it would be better to split the code blocks for ClientApp, ServerApp, Simulation CLI and Simulation Notebook into several (one for current method, other for before 1.1x.0, other for the super legacy method). I think that way would be easier to spot the differences.

doc/source/how-to-upgrade-to-flower-next.rst Outdated Show resolved Hide resolved
doc/source/how-to-upgrade-to-flower-next.rst Outdated Show resolved Hide resolved
@dstripelis
Copy link
Contributor Author

@jafermarq thank you for the insightful feedback. In the latest commit I addressed all comments except for splitting the code blocks for ClientApp, ServerApp, Simulation CLI and Simulation Notebook into several ones. We should do this in the next release since there are many pieces that need to be moved around in order to support this. In the future, we could even have entirely different doc pages for different versions, e.g., <>/1.13/how-to-upgrade-to-flower-next.html , <>/1.14/how-to-upgrade-to-flower-next.html.

Overall the latest commit does the following:

  • Remove using pip header
  • Remove using Poetry header AND section
  • Added ellipsis in place of partitions
  • Removed pyproject.toml config from simulation
  • Added tip suggestion in both CLI and notebook simulations

@chongshenng chongshenng changed the title docs(framework) Update how to upgrade to flower next documentation docs(framework) Update how to upgrade to Flower 1.13 documentation Nov 20, 2024
@danieljanes danieljanes enabled auto-merge (squash) November 20, 2024 14:05
@danieljanes danieljanes merged commit f07881c into main Nov 20, 2024
55 checks passed
@danieljanes danieljanes deleted the how-to-upgrade-flower-next branch November 20, 2024 14:34
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