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 update #592

Merged
merged 3 commits into from
Feb 27, 2023
Merged

Docs update #592

merged 3 commits into from
Feb 27, 2023

Conversation

pimsauter
Copy link
Contributor

  • I agree to contribute to the project under Apache 2 License.
  • To the best of my knowledge, the proposed patch is not based on a code under GPL or other license that is incompatible with FlexMeasures

Signed-off-by: Pim Sauter <pim.sauter@gmail.com>
Signed-off-by: Pim Sauter <pim.sauter@gmail.com>
@pimsauter
Copy link
Contributor Author

One thing that I encountered (working on a Mac now) is that port 5000 is in use by default.

Could add a warning to the docs or change the port to another value, not sure what is best.

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.

Thanks, nice improvements!

@nhoening
Copy link
Contributor

The 5000 port is the default Flask port. It being in use on Mac is of course off-putting. Can you add a warning about that in the docker-compose part of the docs?

For a real solution, I agree we could simply make FlexMeasures use a more unique port number, but we'd have to discuss that in a new issue.

@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 4270433543

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 2 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.01%) to 65.347%

Files with Coverage Reduction New Missed Lines %
flexmeasures/init.py 2 83.33%
Totals Coverage Status
Change from base Build 4093757766: -0.01%
Covered Lines: 6845
Relevant Lines: 9835

💛 - Coveralls

Signed-off-by: Pim Sauter <pim.sauter@gmail.com>
@pimsauter
Copy link
Contributor Author

The 5000 port is the default Flask port. It being in use on Mac is of course off-putting. Can you add a warning about that in the docker-compose part of the docs?

For a real solution, I agree we could simply make FlexMeasures use a more unique port number, but we'd have to discuss that in a new issue.

This is indeed a bit strange, added a note for now.

@Flix6x Flix6x added documentation Improvements or additions to documentation Still Needs Manual Backport labels Feb 27, 2023
@Flix6x Flix6x added this to the 0.12.3 milestone Feb 27, 2023
@Flix6x Flix6x merged commit 08241ca into FlexMeasures:main Feb 27, 2023
Flix6x pushed a commit that referenced this pull request Feb 28, 2023
Improve docker installation tutorial.

* Add pycharm dir to gitignore

Signed-off-by: Pim Sauter <pim.sauter@gmail.com>

* Add docs fixes

Signed-off-by: Pim Sauter <pim.sauter@gmail.com>

* Add note about port 5000 on mac

Signed-off-by: Pim Sauter <pim.sauter@gmail.com>

---------

Signed-off-by: Pim Sauter <pim.sauter@gmail.com>
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.

4 participants