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

Improvements to the Install DXP page #2422

Merged
merged 3 commits into from
Jul 3, 2024
Merged

Conversation

mnocon
Copy link
Contributor

@mnocon mnocon commented Jul 2, 2024

Target: master, 4.6

Things done:

  1. Fixed missing space and wrong usage of eventually. It's a trap that I fall into quite easily, so I started noticing it :D See https://quicksilvertranslate.com/243/false-friends-eventually/
  2. Removed things that are no longer relevant:
  1. We need to send people to Composer doc to install it, because checking the checksum is a security recommendation and we should not advise against it
  2. I want to change the header name for setting up the HTTP server - right now it mentions production, but the very first instruction is for a development setup.
  3. Fixed list formatting in the Elasticsearch article

Previews:
Old: https://doc.ibexa.co/en/latest/getting_started/install_ibexa_dxp/
New: https://ez-systems-developer-documentation--2422.com.readthedocs.build/en/2422/getting_started/install_ibexa_dxp/

Old: https://doc.ibexa.co/en/master/search/search_engines/elastic_search/configure_elastic_search/
New:https://ez-systems-developer-documentation--2422.com.readthedocs.build/en/2422/search/search_engines/elastic_search/configure_elastic_search/

Copy link
Contributor

@juskora juskora left a comment

Choose a reason for hiding this comment

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

@mnocon I know it's not the scope but maybe with this PR we could also get rid of collapsible section in line 134 as it brought some problems recently.

docs/getting_started/install_ibexa_dxp.md Outdated Show resolved Hide resolved
docs/getting_started/install_ibexa_dxp.md Outdated Show resolved Hide resolved
@mnocon
Copy link
Contributor Author

mnocon commented Jul 3, 2024

@mnocon I know it's not the scope but maybe with this PR we could also get rid of collapsible section in line 134 as it brought some problems recently.

We are switching the default PHP version to 8.3 in the upcoming release (next week) and we will have to adjust this section anyway - that's why I didn't touch it in this PR (I agree that we should improve this)

Co-authored-by: Justyna Koralewicz <79849375+juskora@users.noreply.github.com>
@mnocon mnocon merged commit f67e0ca into master Jul 3, 2024
4 checks passed
@mnocon mnocon deleted the install-dxp-improvements branch July 3, 2024 12:40
mnocon added a commit that referenced this pull request Jul 3, 2024
* Improvements to the Install DXP page

* Fixed list formatting in Elasticsearch configuration

* Apply suggestions from code review

Co-authored-by: Justyna Koralewicz <79849375+juskora@users.noreply.github.com>

---------

Co-authored-by: Justyna Koralewicz <79849375+juskora@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants