Create installation Wiki-page #86

Closed
opened 2026-04-01 12:37:27 +00:00 by a24timsv · 16 comments
Collaborator

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 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
Author
Collaborator

The page exists but needs to be populated with detailed instructions.

The page exists but needs to be populated with detailed instructions.
Collaborator

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?

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?
a24timsv removed their assignment 2026-04-02 08:56:30 +00:00
Author
Collaborator

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

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
Collaborator

Alright I can start on that

Alright I can start on that
Collaborator

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

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
Collaborator

I guess I'll start the Linux version

I guess I'll start the Linux version
Collaborator

I will fix the mac version

I will fix the mac version
Collaborator

Linux Part needs review

Linux Part needs review
Author
Collaborator

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.

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.
Author
Collaborator

Updated the Linux part, hopefully it covers all (distro) bases.

Updated the Linux part, hopefully it covers all (distro) bases.
Collaborator

Need review for the Mac part

Need review for the Mac part
Author
Collaborator

@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

docker compose version

is great! I didn't know that compose had a specific version checker. All guides should use this instead of

docker ps
@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 ``` bash docker compose version ``` is great! I didn't know that compose had a specific version checker. All guides should use this instead of ``` bash docker ps ```
Collaborator

The ⇧⌘X (shift + command + x) are Mac keyboard shortcuts

The ⇧⌘X (shift + command + x) are Mac keyboard shortcuts
Collaborator

I will add a note in wiki to clarify this and also do a section about GitHub Desktop

I will add a note in wiki to clarify this and also do a section about GitHub Desktop
Collaborator

I've updated it now, can you review it

I've updated it now, can you review it
Author
Collaborator

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

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
Sign in to join this conversation.
No milestone
No project
4 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Andras/BoundlessFlowCampus2K#86
No description provided.