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

IBX-7966: Ibexa Engage described in Developer documentation #2339

Merged
merged 25 commits into from
Jul 2, 2024

Conversation

julitafalcondusza
Copy link
Contributor

@julitafalcondusza julitafalcondusza commented Mar 22, 2024

Question Answer
JIRA Ticket IBX-7966
Versions master
Edition Experience, Commerce

Ibexa Engage described in Developer documentation.

Preview: https://ez-systems-developer-documentation--2339.com.readthedocs.build/en/2339/ibexa_engage/install_ibexa_engage/

User PR: ibexa/documentation-user#296

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Added link to this PR in relevant JIRA ticket or code PR

Copy link
Contributor

@radzyu radzyu left a comment

Choose a reason for hiding this comment

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

@julitafalcondusza comments added to specific sections.
The dev doc should be also reviewed by the backend team @Steveb-p @adamwojs
Other suggestions (discussed with @SylvainGuittard before):

  • We should somewhere add link to Qualifio dev doc e.g. More details: https://developers.qualifio.com/docs/engage/
  • API key - configuration/setting - it should be explained in the dev doc (Qualifio website with Ibexa DXP)

docs/getting_started/install_on_ibexa_engage.md Outdated Show resolved Hide resolved
docs/getting_started/install_on_ibexa_engage.md Outdated Show resolved Hide resolved
docs/getting_started/install_on_ibexa_engage.md Outdated Show resolved Hide resolved
docs/getting_started/img/campaign_custom_tag.png Outdated Show resolved Hide resolved
docs/getting_started/img/campaign_block.png Outdated Show resolved Hide resolved
docs/getting_started/install_on_ibexa_engage.md Outdated Show resolved Hide resolved
docs/getting_started/install_on_ibexa_engage.md Outdated Show resolved Hide resolved
docs/getting_started/install_on_ibexa_engage.md Outdated Show resolved Hide resolved
@julitafalcondusza julitafalcondusza marked this pull request as ready for review June 3, 2024 12:31
mkdocs.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@radzyu radzyu left a comment

Choose a reason for hiding this comment

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

Some comments added

@julitafalcondusza julitafalcondusza requested a review from radzyu June 7, 2024 07:20
Copy link
Contributor

@radzyu radzyu left a comment

Choose a reason for hiding this comment

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

Comments to screens added.

docs/getting_started/img/create_scenario.png Outdated Show resolved Hide resolved
docs/getting_started/img/campaign_block.png Outdated Show resolved Hide resolved
docs/getting_started/img/configure_ibexa_engage.png Outdated Show resolved Hide resolved
docs/getting_started/img/connect_ibexa_engage.png Outdated Show resolved Hide resolved
docs/ibexa_engage/create_campaign.md Show resolved Hide resolved
docs/ibexa_engage/install_ibexa_engage.md Outdated Show resolved Hide resolved
docs/ibexa_engage/install_ibexa_engage.md Show resolved Hide resolved
docs/ibexa_engage/install_ibexa_engage.md Outdated Show resolved Hide resolved
@julitafalcondusza julitafalcondusza requested a review from radzyu June 21, 2024 12:26
Copy link
Contributor

@mnocon mnocon left a comment

Choose a reason for hiding this comment

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

Looks good, thank you!

I've added a couple of small suggestions - I also think we can improve DX here by expanding the recipes, but that's a question for backend (and does not change this PR)

docs/ibexa_engage/install_ibexa_engage.md Outdated Show resolved Hide resolved
docs/ibexa_engage/integrate_ibexa_connect.md Outdated Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
@julitafalcondusza julitafalcondusza merged commit cba7d75 into master Jul 2, 2024
4 checks passed
@julitafalcondusza julitafalcondusza deleted the IBX-7966 branch July 2, 2024 06:34
julitafalcondusza added a commit that referenced this pull request Jul 2, 2024
* Ibexa Engage described

* Page added in mkdocs

* Updates

* Vale fixes

* Screenshots added

* Updates

* updates

* sentence added

* Fixes

* Ibexa connect part updated

* Screenshots added

* Fixes, place changed

* Fixes, new pages added

* Configuration added

* Fix

* Fixes

* Typo fix

* Links added

* File directory and name added

* Order changed

* Images moved to ibexa engage folder

* Fixes in the structure

* Fixes after review

* PHP CS Fixes

* Fixes after review

---------

Co-authored-by: julitafalcondusza <[email protected]>
Co-authored-by: Julita Falcon Dusza <[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.

7 participants