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

Update composer update documentation #308

Merged
merged 5 commits into from
Jun 13, 2024

Conversation

nick-vanpraet
Copy link
Contributor

Also updated vale documentation link.

I believe I did not tell a lie, but best to have a few eyes on it. I left in all the git stuff, even though nothing mentions you should use git or what it even is but I felt that was out of scope for now.

Copy link
Sponsor Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

Some vale fixes based on the test failures.

Does this also hold true for people using Composer with Recommended Project? Do we also need to warn about for example htaccess which might have custom modifications?

docs/getting_started/how_to_update_mautic.rst Outdated Show resolved Hide resolved
docs/getting_started/how_to_update_mautic.rst Outdated Show resolved Hide resolved
@nick-vanpraet
Copy link
Contributor Author

Does this also hold true for people using Composer with Recommended Project? Do we also need to warn about for example htaccess which might have custom modifications?

This is specifically for people using Recommended Project. Which is the only mention I see in the setup doc pages, so I figure that is the only one we officially support. Anyone who adds packages themselves to their own composer they setup on their own should know enough to manage regardless.

The warnings about git diff and .htaccess are all still present, I just added 2 extra bullet points before the existing ones and rewrote the one that said to run composer update mautic/core-lib.

nick-vanpraet and others added 2 commits June 13, 2024 14:21
Co-authored-by: Ruth Cheesley <ruth@ruthcheesley.co.uk>
Copy link
Sponsor Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

I do think we should clarify the bit about using git diff and when it would be used, but that can be done in another PR.

@RCheesley RCheesley merged commit 06ee167 into mautic:5.x Jun 13, 2024
2 checks passed
@nick-vanpraet nick-vanpraet deleted the update-composer-docs branch June 13, 2024 13:46
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.

None yet

2 participants