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

improve upgrade docs & process for small upgrades #554

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

improve upgrade docs & process for small upgrades #554

craigh opened this issue Oct 27, 2012 · 10 comments

Comments

@craigh
Copy link
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
Copy link

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
Copy link

ghost commented Nov 11, 2013

Running upgrade.php is mandatory.

@cmfcmf
Copy link
Contributor

cmfcmf commented Nov 11, 2013

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

@ghost
Copy link

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
Copy link
Member Author

craigh commented Nov 11, 2013

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

@craigh
Copy link
Member Author

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
Copy link
Contributor

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
Copy link
Member Author

craigh commented Nov 13, 2013

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

@ghost
Copy link

ghost commented Nov 13, 2013

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

@craigh
Copy link
Member Author

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 mentioned this issue Jan 8, 2014
23 tasks
@ghost ghost closed this as completed in 223435b Feb 15, 2014
ghost pushed a commit that referenced this issue Feb 15, 2014
This PR was merged into zikula:1.4 branch.

Discussion
----------

Split developer and user docs, extending install and upgrade docs

This PR is a substantial reworking of the existing document. It's also splits the developer docs from the user docs.

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #554
| Refs tickets  | 
| License       | MIT
| Doc PR        | 

Commits
-------

223435b Split developer and user docs, extending install and upgrade docs. closes #554, rojblake
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants