Create installation Wiki-page #86
Labels
No labels
_CRITICAL_
API
app
backEnd
Blocked, waiting for further changes
bug
cleanup
close
design
duplicate
enhancement
feature request
frontEnd
help wanted
invalid
low priority
needs input
needs review
project documentation
question
research
reviewed
script
security
SQL
style
testing
topLevel
wontfix
No milestone
No project
4 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
Andras/BoundlessFlowCampus2K#86
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
The installation page doesn't exist, and it should. Issue #71, #72, #73 needs to be finished before the installation can be standardized.
Parent issue: #82
The page exists but needs to be populated with detailed instructions.
I could start on creating the windows part of this documentation
I assume we include the prerequisits or should we have them on another part of this page?
The installation guide should be written as being started from nothing to complete setup.
So all prerequisits such as node.js, git, VSC and docker should be included
Alright I can start on that
The windows part is pretty much finished, need someone who uses Linux to do the Linux part and someone who has mac to do the mac part
I guess I'll start the Linux version
I will fix the mac version
Linux Part needs review
Review about the Linux part @c24elipe:
Do we still recommend Docker Desktop for Linux users? Docker Desktop is not really needed since we only use the command line to use it. Windows doesn't allow a pure installation of docker and does this through Docker Desktop instead (using WSL). I think we should at least mentioned that the CLI only version is an option.
Also, the prune command shouldn't be needed since it the script does docker compose --volume that delets all volumes and rebuilds the images.
Updated the Linux part, hopefully it covers all (distro) bases.
Need review for the Mac part
@j21marbr I looked at the Mac part and I just had some thoughts:
In the Visual Studio Code part this combination of symbols exist (⇧⌘X), what are they? It might be something Mac specific that I can't see but I would like to know.
A section about GitHub Desktop is necessary, or at least state that the insallation command installs the Desktop version as well (if it does).
Furthermore, the use of
is great! I didn't know that compose had a specific version checker. All guides should use this instead of
The ⇧⌘X (shift + command + x) are Mac keyboard shortcuts
I will add a note in wiki to clarify this and also do a section about GitHub Desktop
I've updated it now, can you review it
Looks good, I'll close this issue since every version is now made. If something changes or doesn't work this issue will be reopened