Update Dev-Setup Documentation & Add docker folder #1241

hatchla · 2024-04-03T15:31:50Z

Basics

The PR is rebased with current master
I added a line to changelog.md
Details of what I changed are in the commit messages
References to issues, e.g. close #X, are in the commit messages and changelog
The buildserver is happy

Checklist

Review

I've tested the code
I've read through the whole code
I've read through the whole documentation
I've checked conformity to guidelines
I've checked conformity to requirements
I've checked that the requirements are tested

Co-authored-by: hatchla <e12122567@student.tuwien.ac.at>

…the docker container.

hatchla · 2024-04-03T16:02:15Z

jenkins build please

andreicristian97

The files look ok. Could not test the docker setup for "docker+local" as locally I'm only running with the devcontainer, but instructions seem clear.

I've tested the code
I've read through the whole code
I've read through the whole documentation
I've checked conformity to guidelines
I've checked conformity to requirements
I've checked that the requirements are tested

markus2330

Great job. Version numbers somehow got lost. We aim to all use the same versions, to not have additional complexity by supporting multiple compiler versions.

Makefile

markus2330 · 2024-04-06T13:33:30Z

doc/development/01docker+local.md

+
+## Installing Node 20 + Npm
+
+Make sure node 20 is installed, you may use to easly install multiple versions of node [nvm](https://github.com/nvm-sh/nvm),


Try to not have several mentions of which versions to install, this is hard to maintain. (Add link to where the version is already mentioned).

Suggested change

Make sure node 20 is installed, you may use to easly install multiple versions of node [nvm](https://github.com/nvm-sh/nvm),

Make sure node, in the version as required for PermaplanT, is installed, you may use to easily install multiple versions of node [nvm](https://github.com/nvm-sh/nvm),

markus2330 · 2024-04-06T13:35:32Z

doc/development_setup.md

+
+## Ways to develop PermaplanT
+
+Right now we have three different ways to develop Permaplant:


Suggested change

Right now we have three different ways to develop Permaplant:

Right now we have three different ways to develop PermaplanT:

doc/development/01docker+local.md

markus2330 · 2024-04-06T13:38:29Z

doc/development/01docker+local.md

+This runs the Postgis database and PgAdmin.
+
+```bash
+cd docker


Suggested change

cd docker

cd .docker

@horenso simply add/commit suggestion if it is okay.

markus2330 · 2024-04-06T13:38:46Z

docker/.env

rename folder to .docker

chr-schr

Generally I really like the changes as well as separating the different approaches into one file each. 👍
Not sure about the docker container itself, most of it is duplicated with .devcontainer/

chr-schr · 2024-04-06T13:12:06Z

doc/development/03local.md

+
+## Install Rust
+
+Follow the sets to [install Rust using rustup](https://www.rust-lang.org/tools/install).


Suggested change

Follow the sets to [install Rust using rustup](https://www.rust-lang.org/tools/install).

Follow the steps to [install Rust using rustup](https://www.rust-lang.org/tools/install).

chr-schr · 2024-04-06T13:37:08Z

docker/docker-compose.yml

Is it really necessary to more or less duplicate everything from .devcontainers/?
I usually just start the database part of the devcontainer with
docker compose -f .devcontainer/docker-compose.yml up db pgadmin -d
(but have add port forwarding of the db service 5432)

we can also compose it from different compose files for .devcontainer and this setup, it's slightly different for instance it uses the host network

chr-schr · 2024-04-06T13:39:04Z

doc/development/02devcontainer.md

@@ -0,0 +1,30 @@
+# Devcontainer
+
+We are also supporting a containerized setup(docker/podman). For more information checkout the README inside [.devcontainer](https://github.com/ElektraInitiative/PermaplanT/blob/master/.devcontainer/README.md).


Suggested change

We are also supporting a containerized setup(docker/podman). For more information checkout the README inside [.devcontainer](https://github.com/ElektraInitiative/PermaplanT/blob/master/.devcontainer/README.md).

We are also supporting a containerized setup(docker/podman). For more information checkout the README inside [.devcontainer](https://blob.permaplant.net/master/.devcontainer/README.md).

Why can't we use relative links for files in the same repo with ..s?

Generally you can but it in many cases (e.g. links to outside of doc/) it won't work on doc.permaplant.net etc.

chr-schr · 2024-04-06T13:41:49Z

doc/development/01docker+local.md

+Make sure node 20 is installed, you may use to easly install multiple versions of node [nvm](https://github.com/nvm-sh/nvm),
+use apt or [download node directly](https://nodejs.org/en/download).


Suggested change

Make sure node 20 is installed, you may use to easly install multiple versions of node [nvm](https://github.com/nvm-sh/nvm),

use apt or [download node directly](https://nodejs.org/en/download).

Make sure node 20 is installed, you may use [nvm](https://github.com/nvm-sh/nvm) to easily install multiple versions of node, use apt or [download node directly](https://nodejs.org/en/download).

horenso

It should be good now. We can deduplicate the docker setup in an extra PR but I think since this is dev setup only, it's not important.

hatchla · 2024-04-17T18:23:20Z

jenkins build please

horenso · 2024-04-18T20:09:48Z

The only thing touches is the docs and the .docker stuff, I don't know why the build fails...

hatchla · 2024-04-19T07:13:54Z

@filo14 do you have an idea why the build always fails in this PR even though the failing files are not modified?

markus2330 · 2024-04-19T07:19:46Z

@hatchla Afaik @filo14 is already on holidays. Did you try to reproduce the issue locally? Is it maybe already present in master? In such cases, please report issues.

hatchla · 2024-04-19T07:45:19Z

@hatchla Afaik @filo14 is already on holidays. Did you try to reproduce the issue locally? Is it maybe already present in master? In such cases, please report issues.

Was not reproduceable & not present in master.

markus2330

Try to avoid duplication but still be more specific at which versions to use. It is probably best if these 3 variants are just a set of links to other parts of the documentation.

markus2330 · 2024-04-19T08:49:32Z

doc/development/01docker+local.md

+This runs the Postgis database and PgAdmin.
+
+```bash
+cd docker


@horenso simply add/commit suggestion if it is okay.

markus2330 · 2024-04-19T08:50:22Z

doc/development/02devcontainer.md

@@ -0,0 +1,30 @@
+# Devcontainer
+
+We are also supporting a containerized setup(docker/podman). For more information checkout the README inside [.devcontainer](https://github.com/ElektraInitiative/PermaplanT/blob/master/.devcontainer/README.md).


Generally you can but it in many cases (e.g. links to outside of doc/) it won't work on doc.permaplant.net etc.

markus2330 · 2024-04-19T08:51:19Z

doc/development/02devcontainer.md

+
+## Git user
+
+Globally set git credentials are not available in the devcontainer, set them loaclly.


Suggested change

Globally set git credentials are not available in the devcontainer, set them loaclly.

Globally set git credentials are not available in the devcontainer, set them locally.

markus2330 · 2024-04-19T08:52:37Z

doc/development/02devcontainer.md

+
+## Background
+
+(Devcontainer)[https://code.visualstudio.com/docs/devcontainers/containers] allows you to


Markdown is the other way round. Please try to write one sentence per line and keep sentences shorter.

markus2330 · 2024-04-19T08:53:17Z

doc/development/03local.md

+Install postgres, for instance on Ubuntu:
+
+```bash
+apt-get install libpq-dev postgresql-client


Does this install the server?

markus2330 · 2024-04-19T08:54:00Z

doc/development/03local.md

This description is a bit useless? At least links to running frontend+backend should be provided?

markus2330 · 2024-04-19T09:42:46Z

Was not reproduceable & not present in master.

For me pre-commit run --all-files actually fails and hangs on master. See #832

horenso and others added 4 commits March 27, 2024 18:46

Add docker compose to run postgres local.

8965d7a

First draft of new development documentation.

ed8ff21

Co-authored-by: hatchla <e12122567@student.tuwien.ac.at>

Use seperate env files for db and other in docker setup.

719bddb

Don't install e2e in make install since the user may prefer to use …

d4d61ae

…the docker container.

hatchla linked an issue Apr 3, 2024 that may be closed by this pull request

Improve Development setup and docs #1225

Open

4 tasks

Merge branch 'master' into docker-setup

60c8859

hatchla changed the title ~~Docker setup~~ Update Dev-Setup Documentation & Add docker folder Apr 3, 2024

hatchla added the please review Review by unspecified person requested label Apr 3, 2024

hatchla assigned horenso and hatchla Apr 3, 2024

Add line to changelog

dcecd8e

hatchla requested review from markus2330, danielsteinkogler, andreicristian97 and chr-schr April 4, 2024 07:46

Merge branch 'master' into docker-setup

097896e

andreicristian97 approved these changes Apr 4, 2024

View reviewed changes

Merge branch 'master' into docker-setup

811a864

markus2330 suggested changes Apr 6, 2024

View reviewed changes

chr-schr reviewed Apr 6, 2024

View reviewed changes

horenso self-requested a review April 17, 2024 17:27

horenso added 2 commits April 17, 2024 19:38

Incooperate PR suggestions.

90eb7ec

Merge branch 'master' into docker-setup

6d25b34

horenso approved these changes Apr 17, 2024

View reviewed changes

hatchla requested review from markus2330 and chr-schr April 17, 2024 17:45

chr-schr approved these changes Apr 18, 2024

View reviewed changes

markus2330 suggested changes Apr 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Dev-Setup Documentation & Add docker folder #1241

Update Dev-Setup Documentation & Add docker folder #1241

hatchla commented Apr 3, 2024 •

edited

hatchla commented Apr 3, 2024

andreicristian97 left a comment

markus2330 left a comment

markus2330 Apr 6, 2024

markus2330 Apr 6, 2024

markus2330 Apr 6, 2024

markus2330 Apr 19, 2024

markus2330 Apr 6, 2024

chr-schr left a comment

chr-schr Apr 6, 2024

chr-schr Apr 6, 2024

horenso Apr 6, 2024

chr-schr Apr 6, 2024

horenso Apr 6, 2024

markus2330 Apr 19, 2024

chr-schr Apr 6, 2024

horenso left a comment •

edited

hatchla commented Apr 17, 2024

horenso commented Apr 18, 2024

hatchla commented Apr 19, 2024

markus2330 commented Apr 19, 2024

hatchla commented Apr 19, 2024

markus2330 left a comment

markus2330 Apr 19, 2024

markus2330 Apr 19, 2024

markus2330 Apr 19, 2024

markus2330 Apr 19, 2024

markus2330 Apr 19, 2024

markus2330 Apr 19, 2024

markus2330 commented Apr 19, 2024


		## Installing Node 20 + Npm

		Make sure node 20 is installed, you may use to easly install multiple versions of node [nvm](https://github.com/nvm-sh/nvm),

	Make sure node 20 is installed, you may use to easly install multiple versions of node [nvm](https://github.com/nvm-sh/nvm),
	Make sure node, in the version as required for PermaplanT, is installed, you may use to easily install multiple versions of node [nvm](https://github.com/nvm-sh/nvm),


		## Ways to develop PermaplanT

		Right now we have three different ways to develop Permaplant:


		## Install Rust

		Follow the sets to [install Rust using rustup](https://www.rust-lang.org/tools/install).

	Follow the sets to [install Rust using rustup](https://www.rust-lang.org/tools/install).
	Follow the steps to [install Rust using rustup](https://www.rust-lang.org/tools/install).

		@@ -0,0 +1,30 @@
		# Devcontainer

		We are also supporting a containerized setup(docker/podman). For more information checkout the README inside [.devcontainer](https://github.com/ElektraInitiative/PermaplanT/blob/master/.devcontainer/README.md).

		Make sure node 20 is installed, you may use to easly install multiple versions of node [nvm](https://github.com/nvm-sh/nvm),
		use apt or [download node directly](https://nodejs.org/en/download).


		## Git user

		Globally set git credentials are not available in the devcontainer, set them loaclly.


		## Background

		(Devcontainer)[https://code.visualstudio.com/docs/devcontainers/containers] allows you to

Update Dev-Setup Documentation & Add docker folder #1241

Are you sure you want to change the base?

Update Dev-Setup Documentation & Add docker folder #1241

Conversation

hatchla commented Apr 3, 2024 • edited

Basics

Checklist

Review

hatchla commented Apr 3, 2024

andreicristian97 left a comment

Choose a reason for hiding this comment

markus2330 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chr-schr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

horenso left a comment • edited

Choose a reason for hiding this comment

hatchla commented Apr 17, 2024

horenso commented Apr 18, 2024

hatchla commented Apr 19, 2024

markus2330 commented Apr 19, 2024

hatchla commented Apr 19, 2024

markus2330 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

markus2330 commented Apr 19, 2024

hatchla commented Apr 3, 2024 •

edited

horenso left a comment •

edited