feat: documentation using github pages

[Lennart01]

Description

Changelog

Checklist

• [ ] I have performed a self-review of my own code
• [ ] I have commented my code, particularly in hard-to-understand areas
• [ ] The light- and dark-theme are both supported and tested
• [ ] The design was implemented and is responsive for all devices and screen sizes
• [ ] The application was tested in the most commonly used browsers (e.g. Chrome, Firefox, Safari)

(Optional) Visual Changes

[octomind-dev[bot]]

🐙 Octomind

Test Report: 0/14 successful.

description	status	details
About Section Visibility Test	Failed ❌	click
change avatar	Failed ❌	click
check Privacy Policy	Failed ❌	click
check terms & conditions	Failed ❌	click
close cookie banner - front page	Failed ❌	click
close cookie banner - sign-in	Failed ❌	click
create and delete board columns	Failed ❌	click
create_and_delete_notes_and_actions_v2	Failed ❌	click
create lean coffee board	Failed ❌	click
edit_notes_and_actions_v5	Failed ❌	click
get started	Failed ❌	click
share_session	Failed ❌	click
sign-in	Failed ❌	click
test all ways to open the setup flow	Failed ❌	click

commit sha: 960df08

[octomind-dev[bot]]

🐙 Octomind

Test Report: 13/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Failed ❌	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Passed ✅	click

commit sha: 6f2d1b1

[octomind-dev[bot]]

🐙 Octomind

Test Report: 13/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Failed ❌	click
test all ways to open the setup flow	Passed ✅	click

commit sha: 1e5f013

[octomind-dev[bot]]

🐙 Octomind

Test Report: 0/14 successful.

description	status	details
About Section Visibility Test	Failed ❌	click
change avatar	Failed ❌	click
check Privacy Policy	Failed ❌	click
check terms & conditions	Failed ❌	click
close cookie banner - front page	Failed ❌	click
close cookie banner - sign-in	Failed ❌	click
create and delete board columns	Failed ❌	click
create_and_delete_notes_and_actions_v2	Failed ❌	click
create lean coffee board	Failed ❌	click
edit_notes_and_actions_v5	Failed ❌	click
get started	Failed ❌	click
share_session	Failed ❌	click
sign-in	Failed ❌	click
test all ways to open the setup flow	Failed ❌	click

commit sha: 7c38074

[octomind-dev[bot]]

🐙 Octomind

Test Report: 13/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Failed ❌	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Passed ✅	click

commit sha: 92cdab4

[octomind-dev[bot]]

🐙 Octomind

Test Report: 6/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Failed ❌	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Failed ❌	click
create_and_delete_notes_and_actions_v2	Failed ❌	click
create lean coffee board	Failed ❌	click
edit_notes_and_actions_v5	Failed ❌	click
get started	Passed ✅	click
share_session	Failed ❌	click
sign-in	Failed ❌	click
test all ways to open the setup flow	Failed ❌	click

commit sha: 524ae74

[octomind-dev[bot]]

🐙 Octomind

Test Report: 6/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Failed ❌	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Failed ❌	click
create_and_delete_notes_and_actions_v2	Failed ❌	click
create lean coffee board	Failed ❌	click
edit_notes_and_actions_v5	Failed ❌	click
get started	Passed ✅	click
share_session	Failed ❌	click
sign-in	Failed ❌	click
test all ways to open the setup flow	Failed ❌	click

commit sha: 29ec4ac

[octomind-dev[bot]]

🐙 Octomind

Test Report: 6/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Failed ❌	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Failed ❌	click
create_and_delete_notes_and_actions_v2	Failed ❌	click
create lean coffee board	Failed ❌	click
edit_notes_and_actions_v5	Failed ❌	click
get started	Passed ✅	click
share_session	Failed ❌	click
sign-in	Failed ❌	click
test all ways to open the setup flow	Failed ❌	click

commit sha: dbb9119

[brandstetterm]

Tbh I would prefer this to be in a separate GitHub repository :D

[Schwehn42]

Tbh I would prefer this to be in a separate GitHub repository :D

why?

[Schwehn42]

I prefer it in here, if it's in another repo I can already see information not being up to date because it was forgotten. The main repository is the most accessible not only for us devs, but also the first place to look for anyone who actually needs them. Furthermore once this is integrated I'm assuming the information won't change that frequently so I don't believe it's going to get in our way.

[brandstetterm]

Tbh I would prefer this to be in a separate GitHub repository :D

why?

Because the codebase & commit history of the main application should be kept clean in my opinion. For the same reason, the landing page is a separate project.

Also, as far as I've seen, the GitHub action to deploy the documentation to GitHub pages is planned to run on every commit on main. With 99% of all commits probably not being related to the documentation, that's unnecessary.

[Schwehn42]

Also, as far as I've seen, the GitHub action to deploy the documentation to GitHub pages is planned to run on every commit on main. With 99% of all commits probably not being related to the documentation, that's unnecessary.

Since a commit to main equals a merged PR, I think it would be interesting to know if the whole documentation changes even though something completely unrelated was commited or only the relevant parts are affected. Because in the first case, I completely agree with as this would clutter the history, but if it's a smart tool I think it would be nice to have the most up to date documentation within the same repo.

[Schwehn42]

That being said I don't insist on this, so if you really say this is better for the reasons described then I don't mind as well

[Lennart01]

Tbh I would prefer this to be in a separate GitHub repository :D

why?

Because the codebase & commit history of the main application should be kept clean in my opinion. For the same reason, the landing page is a separate project.

Also, as far as I've seen, the GitHub action to deploy the documentation to GitHub pages is planned to run on every commit on main. With 99% of all commits probably not being related to the documentation, that's unnecessary.

Which is something we can tackle. We can only run the docs pipeline if we made changes to the folder like this. I think landing Page and documentation are completely unrelated and I agree with Jakob here.

[octomind-dev[bot]]

🐙 Octomind

Test Report: 14/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Passed ✅	click

commit sha: 3fd2082

[octomind-dev[bot]]

🐙 Octomind

Test Report: 14/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Passed ✅	click

commit sha: a9b9f57

[octomind-dev[bot]]

🐙 Octomind

Test Report: 14/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Passed ✅	click

commit sha: a0b77fd

[octomind-dev[bot]]

🐙 Octomind

Test Report: 14/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Passed ✅	click

commit sha: 4a03d1e

[octomind-dev[bot]]

🐙 Octomind

Test Report: 14/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Passed ✅	click

commit sha: 99122aa

[octomind-dev[bot]]

🐙 Octomind

Test Report: 14/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Passed ✅	click

commit sha: c73da6c

[octomind-dev[bot]]

🐙 Octomind

Test Report: 13/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Failed ❌	click

commit sha: b52cf1d

[octomind-dev[bot]]

🐙 Octomind

Test Report: 13/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Passed ✅	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Failed ❌	click

commit sha: b52cf1d

[octomind-dev[bot]]

🐙 Octomind

Test Report: 12/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Failed ❌	click
edit_notes_and_actions_v5	Passed ✅	click
get started	Passed ✅	click
share_session	Failed ❌	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Passed ✅	click

commit sha: 6657b35

[github-actions[bot]]

The deployment to the dev cluster was successful. You can find the deployment here: https://4086.development.scrumlr.fra.ics.inovex.io This deployment is only for testing purposes and will be deleted after 1 week. To redeploy rerun the workflow. DO NOT STORE IMPORTANT DATA ON THIS DEPLOYMENT

Deployed Images

• ghcr.io/inovex/scrumlr.io/scrumlr-frontend:sha-b30eff3

• ghcr.io/inovex/scrumlr.io/scrumlr-server:sha-b30eff3

[octomind-dev[bot]]

🐙 Octomind

Test Report: 12/14 successful.

description	status	details
About Section Visibility Test	Passed ✅	click
change avatar	Passed ✅	click
check Privacy Policy	Passed ✅	click
check terms & conditions	Passed ✅	click
close cookie banner - front page	Passed ✅	click
close cookie banner - sign-in	Passed ✅	click
create and delete board columns	Passed ✅	click
create_and_delete_notes_and_actions_v2	Passed ✅	click
create lean coffee board	Failed ❌	click
edit_notes_and_actions_v5	Failed ❌	click
get started	Passed ✅	click
share_session	Passed ✅	click
sign-in	Passed ✅	click
test all ways to open the setup flow	Passed ✅	click

commit sha: b30eff3