Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2024-07-20-adapt-documentation_installation #331

Merged
merged 19 commits into from
Sep 4, 2024

Conversation

sjib
Copy link
Contributor

@sjib sjib commented Jul 20, 2024

General

  • Fix the documentation

Context

Installation documentation is not up to date and leads to error in testing TWW.

Describe your changes

  • Fix the installation documentation
  • Remove the VM obsolete approach
  • Mention the upcoming evolution in roles management

Screenshots

Issue ticket number and link

Checklist before requesting a review

  • I have performed a self-review of my code
  • If it is a core feature, I have added thorough tests.
  • CI Tests are green
  • The documentation is up to date with the proposed change.
  • My work is ready for review

Checklist before merge

  • A review has been performed
  • Comments are resolved
  • Documentation is ready

@sjib
Copy link
Contributor Author

sjib commented Jul 20, 2024

* Right click the `tww_prod` database

  * Click `Restore`

  * Load your download of tww_vx.y.z_structure_and_demo_data.backup

I suggest to call it tww_demo in this paragraph:

  • Right click the tww_demo database

@sjib sjib requested a review from ponceta July 20, 2024 19:09
@sjib sjib self-assigned this Jul 20, 2024
@sjib sjib added documentation Improvements or additions to documentation TEKSI wastewater labels Jul 20, 2024
@sjib
Copy link
Contributor Author

sjib commented Jul 20, 2024

@ponceta Can we have

  • a tww_dev_structure_and_demo_data.backup (with demodata)
  • and one just the structure?

Currently the CI only creates one without demodata, but it is called with demodata )
tww_dev_structure_and_demo_data.backup )

@sjib
Copy link
Contributor Author

sjib commented Jul 20, 2024

@ponceta Adapt from dev to 2024.0

@sjib
Copy link
Contributor Author

sjib commented Jul 20, 2024

2.4.5. Install the demo project

    Download from https://github.com/TWW/tww/releases/latest the tww.zip

    Extract the file

The project file currently is in a zip called project-translations.zip

@sjib
Copy link
Contributor Author

sjib commented Jul 20, 2024

@sjib sjib requested review from urskaufmann and cymed and removed request for urskaufmann September 4, 2024 06:04
@sjib
Copy link
Contributor Author

sjib commented Sep 4, 2024

@cymed Can you review this based on your latest developments with roles?

@cymed
Copy link
Contributor

cymed commented Sep 4, 2024

My roles developments have a separate docs update. Also there are conflicts to resolve

@ponceta ponceta closed this Sep 4, 2024
@ponceta ponceta reopened this Sep 4, 2024
…emodata

Fix duplicate role initialization and explain actual limitations of demodata
AS it is not maintained nor supported anymore. A cloud base VM should be implemented in the next years to provide a visual and online demo.
@ponceta ponceta merged commit 5f4aa0c into main Sep 4, 2024
3 checks passed
@ponceta ponceta deleted the 2024-07-20-adapt-documentation_installation branch September 4, 2024 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation TEKSI wastewater
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants