improve upgrade docs & process for small upgrades #554

Closed
craigh opened this Issue Oct 27, 2012 · 10 comments

Projects

None yet

2 participants

@craigh
Member
craigh commented Oct 27, 2012

The upgrade document is apparently only for upgrading from 1.2.x -> 1.3.x and doesn't seem to relate to small incremental upgrades like 1.3.3 -> 1.3.4. I would like to upgrade but I don't know if I need to run upgrade.php or not. So, I check upgrade.php and it looks like it is all related to the first option (1.2.x->1.3.x) and isn't obvious what will happen upgrading from 1.3.3 -> 1.3.4. I'd like to see the upgrade.php file more documented (both in docs and inline) and maybe less procedural code? At least the upgrade doc should be clarified before the 1.3.5 release.

@ghost
ghost commented Oct 31, 2012

The UPGRADING doc could be renamed UPGRADING-1.2.md since it's the special case, then have a separate doc for 1.3+ upgrades.

@ghost
ghost commented Nov 11, 2013

Running upgrade.php is mandatory.

@cmfcmf
Member
cmfcmf commented Nov 11, 2013

Great that the news articles on 1.3.6 say it isn't......

@ghost
ghost commented Nov 11, 2013

ping @craigh

Running upgrade.php, even if there is nothing to do, it updates the core version in the database which is necessary for future upgraders to know what's what.

@craigh
Member
craigh commented Nov 11, 2013

that's why I asked you to read the article ;-) You've corrected it I assume?

@craigh craigh referenced this issue Nov 13, 2013
Merged

update upgrade.php for v1.3.6 -> 1.3.7 #1384

0 of 2 tasks complete
@craigh
Member
craigh commented Nov 13, 2013

so the documentation has been removed from the repo. the docs on the community site are ancient. They need to be somewhere. do we want them in a github wiki? the repo? https://github.com/zikula/zikula-docs ?

@drak @paustian @cmfcmf

@cmfcmf
Member
cmfcmf commented Nov 13, 2013

Could someone with apropriate permission please update the german news article as well (that upgrade.php has to be run)? @rallek @guite

@craigh
Member
craigh commented Nov 13, 2013

so - @drak - where to put upgrading and install docs?

@ghost
ghost commented Nov 13, 2013

Can we leave this until nearer release? We dont know what the upgrade process will be entirely yet.

@craigh
Member
craigh commented Nov 13, 2013

I guess so. I'm just trying to close tickets. (#1384)

ok - I JUST (re)noticed this file: https://github.com/zikula/core/blob/1.3/UPGRADE-1.3.7.md

I guess that goes toward the proper docs that need to be created eventually. It should be separated from site admins and devs though.

anyway, I wanted to change this line in the upgrade.php file: https://github.com/zikula/core/blob/1.3/src/upgrade.php#L131

it has wrong information/links.

@craigh craigh added a commit to craigh/core that referenced this issue Nov 17, 2013
@craigh craigh update upgrade.php for v1.3.6 -> 1.3.7 refs #554 bdd3813
@ghost ghost closed this in 223435b Feb 15, 2014
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment