Update Documentation #4419
Closed
Update Documentation #4419
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
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.
Motivation: The current documentation regarding the local deployment of BlueSky is
sparse and could be improved.
Currently, the build.md file is used for local deployment of the system. However, this file is a bit unstructured and not easy-to-read for newcomers or developers with not much experience. Furthermore, it is assumed that the user has previously installed
certain packages or that the user has knowledge related to setting environment variables.
The proposal is to improve the existing markdown file in which, with the help
of images, a step-by-step local deployment is detailed, including solutions to possible errors
that the user may encounter.