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

Update Docker Setup Instructions and Refactor Toy Example Section #896

Merged
merged 4 commits into from
Nov 8, 2023

Conversation

briskdust
Copy link
Contributor

Description:

This PR introduces several enhancements to the tutorial documentation for setting up FlexMeasures with Docker. Key changes include:

  1. Clearer Docker Setup Instructions: The process of creating Docker containers and upgrading the FlexMeasures database has been made more transparent. A clear distinction is now drawn to inform users that the image pull and network creation steps aren't required when recreating containers, simplifying the process for users who need to restart their setup.

  2. Removal of Duplicate Content: A duplicate section detailing the installation process was identified and has been removed to prevent confusion.

  3. Separation of Code Blocks in Toy Example: The code block containing two distinct commands has been split, allowing users to more easily copy and paste individual commands, thus enhancing usability and reducing the potential for errors during setup.

These updates should make the tutorial more user-friendly, especially for beginners navigating the setup for the first time.

@nhoening nhoening added the documentation Improvements or additions to documentation label Nov 8, 2023
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

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

Great, thanks.

@nhoening nhoening merged commit ffc3f36 into main Nov 8, 2023
8 of 9 checks passed
@nhoening nhoening deleted the tutorial-review branch November 8, 2023 22:55
@Flix6x Flix6x added this to the 0.18.0 milestone Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants