[Upgrade] Providing adequate documentation to the providers to make the upgrade process as easy and as smooth as possible

[ponceta]

Objective

When doing an upgrade, the TEKSI provider should find all good information to make the upgrade as simple and as smooth as possible.

How it works

This is made possible :

• With a adequate documentation including
  • changelogs
    • breaking changes
    • new features
    • fixed bugs
    • Removed items of features

It has to be clear, structured, relevant, reliable and accessible :
See https://github.com/teksi/Home/wiki/ChangelogQuality

• A template should be provided for changelogs (see sample here)
• Concerned People (contributors, developers, reviewers, release managers) should be aware of the documentation policy

Configuration

To complete

• Parameters :

Field	Type	Mandatory	Example
id	int4	Primary key

Other

Additional informations/requirements

Acceptation criteria

Identifier	Description
#ISSUE-1	It works
#ISSUE-2	It works everytime
#ISSUE-3	It works on all systems

[sjib]

@tproduit Can you update the phase_3 issues for tomorrows demo so that there is a clear picture of the status of this phase? And give all others a phase tag.

[sjib]

We have 5 different installation instructions available:

• https://github.com/teksi/TMMT
• 🥳 TMMT is LIVE for TEKSI Modules installation #34
• 🧙‍♂️ NEW TEKSI MODULE MANAGEMENT TOOL (TMMT) is available for TESTING 🥳 #66
• https://github.com/orgs/teksi/discussions/125
• https://opengisch.github.io/oqtopus/ (the real docu link) with https://opengisch.github.io/oqtopus/installation/

We should have a TMMT based installation instructions which is referring to https://opengisch.github.io/oqtopus/ if needed

There are conflicting informations:
Requirements:

• pip install --upgrade pum pydantic psycopg (on https://opengisch.github.io/oqtopus/installation/)
• But pip install --upgrade --user pydantic psycopg (on 🥳 TMMT is LIVE for TEKSI Modules installation #34, already harmonized with https://github.com/orgs/teksi/discussions/125 and 🧙‍♂️ NEW TEKSI MODULE MANAGEMENT TOOL (TMMT) is available for TESTING 🥳 #66)

@ponceta @tproduit Which one is correct?

[3nids]

the oQtoups install docs were wrong, just fixed.

pip install --upgrade --user pydantic psycopg is correct.

[sjib]

@3nids https://opengisch.github.io/oqtopus/installation/ hast still pip install --upgrade pydantic psycopg - what about --user ?