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

Add an upgrade guide to the documentation #8

Merged
merged 10 commits into from
Oct 14, 2021
Merged

Add an upgrade guide to the documentation #8

merged 10 commits into from
Oct 14, 2021

Conversation

rowild
Copy link
Contributor

@rowild rowild commented Oct 14, 2021

Add upgrade guide as discussed here: #7

@rowild
Copy link
Contributor Author

rowild commented Oct 14, 2021

I have no idea why this PR shows other commits from 4 months ago... I forked the repo anew and created a dedicated branch for this commit. However, it seems that I did something wrong. If this causes any troubles, let me know and I provide a new PR.

Set to "In progress" for the moment.

@rowild rowild marked this pull request as draft October 14, 2021 11:42
@rowild
Copy link
Contributor Author

rowild commented Oct 14, 2021

In a commit I wrote:

The upgrade guide tries to cover as many steps as possible, at least those I encountered during the update. Is there anything I didn't think of? Or do you think those are too many?

Please let me know! Thanks!

@gilbertsoft
Copy link
Member

I have no idea why this PR shows other commits from 4 months ago... I forked the repo anew and created a dedicated branch for this commit. However, it seems that I did something wrong. If this causes any troubles, let me know and I provide a new PR.

Set to "In progress" for the moment.

Did you also delete your local clone? If you remove the fork the new one should be up to date with the upstream. And since some time there is a new feature at GH to synchronize your existing fork with the upstream:

grafik

But it looks this should not be an issue, no changes are shown from the previous commits.

@gilbertsoft
Copy link
Member

gilbertsoft commented Oct 14, 2021

Thanks for your PR. I like to get rid of the current issues in

# Setup links according to the docs see https://docs.typo3.org/m/typo3/guide-installation/master/en-us/QuickInstall/GetAndUnpack/Index.html
echo -e "${COLOR_INFORMATION}Create symlinks...${COLOR_RESET}"
echo -e " ${TYPO3_SRC_DIRECTORY} -> ${DDEV_DOCROOT}/typo3_src"
ln -frs "${TYPO3_SRC_DIRECTORY}" "${DDEV_DOCROOT}/typo3_src"
echo -e " ${TYPO3_SRC_DIRECTORY}/index.php -> ${DDEV_DOCROOT}/index.php"
ln -frs "${TYPO3_SRC_DIRECTORY}/index.php" "${DDEV_DOCROOT}/index.php"
echo -e " ${TYPO3_SRC_DIRECTORY}/typo3 -> ${DDEV_DOCROOT}/typo3"
ln -frs "${TYPO3_SRC_DIRECTORY}/typo3" "${DDEV_DOCROOT}/typo3"

After that the upgrade instruction should get shorter...

I will add my changes to your PR here so we get rid of it in one step.

@rowild
Copy link
Contributor Author

rowild commented Oct 14, 2021

Thinking out loud: Reading through the TYPO3 and the ddev docs I observe that the public folder is usually called just that: public. This repo, however, uses htdocs. I was wondering if going along with the more-or-less standard naming conventions wouldn't be better?

@gilbertsoft
Copy link
Member

Thinking out loud: Reading through the TYPO3 and the ddev docs I observe that the public folder is usually called just that: public. This repo, however, uses htdocs. I was wondering if going along with the more-or-less standard naming conventions wouldn't be better?

I've called it htdocs back then because many cheap hosters name it like this. But you can simply change it in the config.yaml, the install script reads that path from the environment variable.

Copy link
Member

@gilbertsoft gilbertsoft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I did some minor changes and also added my fix of the install script. I did a force push to the branch to get rid of the 3 unwanted commits so please use git pull --force to get these changes.

README.md Outdated Show resolved Hide resolved
@rowild rowild marked this pull request as ready for review October 14, 2021 19:13
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@gilbertsoft gilbertsoft merged commit 4cdc217 into GsTYPO3:main Oct 14, 2021
gilbertsoft added a commit that referenced this pull request Oct 14, 2021
* [BUGFIX] Fix installation with existing files

* [DOCS] Add upgrade guide

* [DOCS] Make upgrades easier

* Move "deleted db" scenario to "trouble shooting"

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

Co-authored-by: Simon Gilli <[email protected]>
gilbertsoft added a commit that referenced this pull request Oct 16, 2021
* [BUGFIX] Fix installation with existing files

* [DOCS] Add upgrade guide

* [DOCS] Make upgrades easier

* Move "deleted db" scenario to "trouble shooting"

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

Co-authored-by: Simon Gilli <[email protected]>
gilbertsoft added a commit that referenced this pull request Oct 16, 2021
* [BUGFIX] Fix installation with existing files

* [DOCS] Add upgrade guide

* [DOCS] Make upgrades easier

* Move "deleted db" scenario to "trouble shooting"

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

Co-authored-by: Simon Gilli <[email protected]>
gilbertsoft added a commit that referenced this pull request Oct 16, 2021
* [BUGFIX] Fix installation with existing files

* [DOCS] Add upgrade guide

* [DOCS] Make upgrades easier

* Move "deleted db" scenario to "trouble shooting"

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

Co-authored-by: Simon Gilli <[email protected]>
gilbertsoft added a commit that referenced this pull request Oct 16, 2021
* [BUGFIX] Fix installation with existing files

* [DOCS] Add upgrade guide

* [DOCS] Make upgrades easier

* Move "deleted db" scenario to "trouble shooting"

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

Co-authored-by: Simon Gilli <[email protected]>
gilbertsoft added a commit that referenced this pull request Oct 16, 2021
* [BUGFIX] Fix installation with existing files

* [DOCS] Add upgrade guide

* [DOCS] Make upgrades easier

* Move "deleted db" scenario to "trouble shooting"

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

Co-authored-by: Simon Gilli <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants