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-8689: AI Actions documentation #2473

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open

IBX-8689: AI Actions documentation #2473

wants to merge 22 commits into from

Conversation

dabrt
Copy link
Contributor

@dabrt dabrt commented Aug 20, 2024

Question Answer
JIRA Ticket IBX-8689
Versions 4.6 and up
Edition all

Prepare the documentation of AI Actions LTS Update.

Entry point:
https://ez-systems-developer-documentation--2473.com.readthedocs.build/en/2473/release_notes/ibexa_dxp_v4.6/#lts-updates

Checklist

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

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.

As we've discussed - I like it! Just a couple of smaller comments

docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/install_ai_actions.md Outdated Show resolved Hide resolved
docs/ai_actions/install_ai_actions.md Outdated Show resolved Hide resolved
docs/ai_actions/install_ai_actions.md Outdated Show resolved Hide resolved
docs/ai_actions/install_ai_actions.md Outdated Show resolved Hide resolved
@dabrt dabrt requested a review from mnocon October 23, 2024 20:10
@dabrt
Copy link
Contributor Author

dabrt commented Oct 23, 2024

@mnocon Feel free to leave comments and add your content

code_samples/ai_actions/config/add_ai_actions.sql Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/install_ai_actions.md Outdated Show resolved Hide resolved
docs/ai_actions/install_ai_actions.md Outdated Show resolved Hide resolved
docs/ai_actions/install_ai_actions.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/ai_actions/install_ai_actions.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
@dabrt dabrt requested a review from bdunogier November 7, 2024 19:01
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
docs/ai_actions/ai_actions_guide.md Outdated Show resolved Hide resolved
@dabrt dabrt requested a review from bdunogier November 8, 2024 15:13
dabrt and others added 2 commits November 8, 2024 17:43
* add_ai_actions.sql: Upper case; empty new line at end of file

* add_ai_actions.sql: Upper case; empty new line at end of file
Copy link

github-actions bot commented Nov 8, 2024

code_samples/ change report

Before (on target branch)After (in current PR)

code_samples/ai_actions/config/mysql/add_ai_actions.sql


code_samples/ai_actions/config/mysql/add_ai_actions.sql

docs/ai_actions/install_ai_actions.md@45:    ``` sql
docs/ai_actions/install_ai_actions.md@46: [[= include_file('code_samples/ai_actions/config/mysql/add_ai_actions.sql', 0, None, ' ') =]]
docs/ai_actions/install_ai_actions.md@47: ```

001⫶ CREATE TABLE ibexa_action_configuration
002⫶ (
003⫶ id INT auto_increment PRIMARY KEY,
004⫶ identifier VARCHAR(64) NOT NULL,
005⫶ type VARCHAR(32) NOT NULL,
006⫶ enabled TINYINT(1) NOT NULL,
007⫶ action_type_options JSON NULL,
008⫶ action_handler_options JSON NULL,
009⫶ action_handler_identifier VARCHAR(64) NULL,
010⫶ created_at DATETIME NULL COMMENT '(DC2Type:datetime_immutable)',
011⫶ updated_at DATETIME NULL COMMENT '(DC2Type:datetime_immutable)',
012⫶ CONSTRAINT ibexa_action_configuration_identifier_uc
013⫶ UNIQUE (identifier)
014⫶ ) COLLATE = utf8mb4_unicode_520_ci;
015⫶
016⫶ CREATE INDEX ibexa_action_configuration_enabled_idx
017⫶ ON ibexa_action_configuration (enabled);
018⫶
019⫶ CREATE INDEX ibexa_action_configuration_identifier_idx
020⫶ ON ibexa_action_configuration (identifier);
021⫶
022⫶ CREATE TABLE ibexa_action_configuration_ml
023⫶ (
024⫶ id INT auto_increment PRIMARY KEY,
025⫶ action_configuration_id INT NOT NULL,
026⫶ language_id BIGINT NOT NULL,
027⫶ name VARCHAR(190) NOT NULL,
028⫶ description LONGTEXT NULL,
029⫶ CONSTRAINT ibexa_action_configuration_ml_uidx
030⫶ UNIQUE (action_configuration_id, language_id),
031⫶ CONSTRAINT ibexa_action_configuration_ml_to_action_configuration_fk
032⫶ FOREIGN KEY (action_configuration_id) REFERENCES ibexa_action_configuration (id)
033⫶ ON UPDATE CASCADE ON DELETE CASCADE,
034⫶ CONSTRAINT ibexa_action_configuration_ml_to_language_fk
035⫶ FOREIGN KEY (language_id) REFERENCES ezcontent_language (id)
036⫶ ON UPDATE CASCADE ON DELETE CASCADE
037⫶ ) COLLATE = utf8mb4_unicode_520_ci;
038⫶
039⫶ CREATE INDEX ibexa_action_configuration_ml_action_configuration_idx
040⫶ ON ibexa_action_configuration_ml (action_configuration_id);
041⫶
042⫶ CREATE INDEX ibexa_action_configuration_ml_language_idx
043⫶ ON ibexa_action_configuration_ml (language_id);


code_samples/ai_actions/config/postgresql/add_ai_actions.sql


code_samples/ai_actions/config/postgresql/add_ai_actions.sql

docs/ai_actions/install_ai_actions.md@51:    ``` sql
docs/ai_actions/install_ai_actions.md@52: [[= include_file('code_samples/ai_actions/config/postgresql/add_ai_actions.sql', 0, None, ' ') =]]
docs/ai_actions/install_ai_actions.md@53: ```

001⫶ CREATE TABLE ibexa_action_configuration (id SERIAL NOT NULL, identifier VARCHAR(64) NOT NULL, type VARCHAR(32) NOT NULL, enabled BOOLEAN NOT NULL, action_type_options JSON DEFAULT NULL, action_handler_options JSON DEFAULT NULL, action_handler_identifier VARCHAR(64) DEFAULT NULL, created_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL, updated_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL, PRIMARY KEY(id));
002⫶ CREATE INDEX ibexa_action_configuration_identifier_idx ON ibexa_action_configuration (identifier);
003⫶ CREATE INDEX ibexa_action_configuration_enabled_idx ON ibexa_action_configuration (enabled);
004⫶ CREATE UNIQUE INDEX ibexa_action_configuration_identifier_uc ON ibexa_action_configuration (identifier);
005⫶ COMMENT ON COLUMN ibexa_action_configuration.created_at IS '(DC2Type:datetime_immutable)';
006⫶ COMMENT ON COLUMN ibexa_action_configuration.updated_at IS '(DC2Type:datetime_immutable)';
007⫶ CREATE TABLE ibexa_action_configuration_ml (id SERIAL NOT NULL, action_configuration_id INT NOT NULL, language_id BIGINT NOT NULL, name VARCHAR(190) NOT NULL, description TEXT DEFAULT NULL, PRIMARY KEY(id));
008⫶ CREATE INDEX ibexa_action_configuration_ml_name_idx ON ibexa_action_configuration_ml (name);
009⫶ CREATE INDEX ibexa_action_configuration_ml_language_idx ON ibexa_action_configuration_ml (language_id);
010⫶ CREATE INDEX ibexa_action_configuration_ml_action_configuration_idx ON ibexa_action_configuration_ml (action_configuration_id);
011⫶ CREATE UNIQUE INDEX ibexa_action_configuration_ml_uidx ON ibexa_action_configuration_ml (action_configuration_id, language_id);
012⫶ ALTER TABLE ibexa_action_configuration_ml ADD CONSTRAINT ibexa_action_configuration_ml_to_language_fk FOREIGN KEY (language_id) REFERENCES ezcontent_language (id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;
013⫶ ALTER TABLE ibexa_action_configuration_ml ADD CONSTRAINT ibexa_action_configuration_ml_to_action_configuration_fk FOREIGN KEY (action_configuration_id) REFERENCES ibexa_action_configuration (id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE;

Download colorized diff

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.

4 participants