cypht-org / cypht-website

cypht.org website
Other
7 stars 23 forks source link

install.html updated according to the last migration of cypht to dotenv #49

Closed Shadow243 closed 6 months ago

Shadow243 commented 10 months ago

Cypht Migration Updates

As requested https://avan.tech/item98840, the install.html has been updated to accommodate updates related to Cypht's migration from hm3.ini to .env file configurations.

marclaporte commented 8 months ago

Some people use Cypht 1.4.x Some people use Cypht master (which will soon become 2.0)

Given the massive changes we made for 2.0, we will support 1.4.x for a while after the release of 2.0

So I guess we need two pages?

marclaporte commented 8 months ago

See also: https://github.com/cypht-org/cypht-website/pull/46

Shadow243 commented 8 months ago

One with hm3.ini(the old structure) and the other one for dotenv updates?

configuration structure has completely changed, it will indeed be difficult for someone using version 1.4.x to find the documentation with hm3.ini.

It may be necessary to give it the opportunity to choose the version to read here: install.html (2 pages).

Some people use Cypht 1.4.x Some people use Cypht master (which will soon become 2.0)

Given the massive changes we made for 2.0, we will support 1.4.x for a while after the release of 2.0

So I guess we need two pages?

marclaporte commented 8 months ago

So I guess we need two pages?

Yes

marclaporte commented 8 months ago

And please keep in mind recent changes like https://github.com/cypht-org/cypht-website/pull/46

Shadow243 commented 8 months ago

install-dotenv.html add in separation with install.html which explains the installation of the version that supports hm3.ini

marclaporte commented 8 months ago

In 4-8 weeks, we will release Cypht 2.0 which has many enhancements including environment variables.

Once Cypht 2.0 is released, we will continue to maintain Cypht 1.4.x for security fixes (and maybe bug fixes) for a few months, maybe more.

Tiki 24x bundles Cypht 1.4.x Tiki 27x bundles Cypht 2.x

Then, Cypht master will evolve from which we will release 2.1 or 3.0

install-dotenv.html will confuse some users as they have no idea what is an environment variable. I suggest to spli as follows

Shadow243 commented 8 months ago

In 4-8 weeks, we will release Cypht 2.0 which has many enhancements including environment variables.

Once Cypht 2.0 is released, we will continue to maintain Cypht 1.4.x for security fixes (and maybe bug fixes) for a few months, maybe more.

Tiki 24x bundles Cypht 1.4.x Tiki 27x bundles Cypht 2.x

Then, Cypht master will evolve from which we will release 2.1 or 3.0

install-dotenv.html will confuse some users as they have no idea what is an environment variable. I suggest to spli as follows

  • install-1x.html
  • install-2x.html

Renamed to install-1x.html and install-2x.html Done.

Baraka24 commented 8 months ago

What if users are on windows operating systems? This install documentation fits Linux, Debian, Mac users only... shouldn't we provide windows users steps too? @Shadow243.

marclaporte commented 7 months ago

shouldn't we provide windows users steps too?

Good point @Baraka24 Please handle in a different MR with @aggestor @IrAlfred @Bienvenumoringa as part of your dev documentation review.

marclaporte commented 4 months ago

First issue: There are links to https://www.cypht.org/install.html that are now broken. When a page is deleted, it's a good practice to put a permanent redirect.

Second issue: We should also have a page to install Cypht master (future Cypht 3.0) which now requires PHP 8.1

I suggest to put back a page at https://www.cypht.org/install.html and on there, offer links to Cypht 1.x, 2.x and master