Updated README installation #271
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rimi-itk
requested changes
Jan 18, 2024
README.md
Outdated
Comment on lines
17
to
22
|
|
||
| # Important: If there is no need for organisation data you must also create the following network. | ||
| docker network create serviceplatformen_organisation_api_app | ||
| # If you wish to use organisation | ||
| # @see https://github.com/itk-dev/serviceplatformen_organisation_api?tab=readme-ov-file#using-the-api-from-another-docker-compose-setup | ||
|
|
There was a problem hiding this comment.
I think you should move this outside the code block and put it just under the “Installation” heading and write something along the lines of
The development setup depends on the
serviceplatformen_organisation_api_appnetwork which is used to access the API from https://github.com/itk-dev/serviceplatformen_organisation_api. If you start that project (cf. Getting started), you're good to go. If you don't need the API during development, you can manually create the network by running
docker network create serviceplatformen_organisation_api_app
rimi-itk
approved these changes
Jan 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates
READMEwith missing network