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.

Sign up for GitHub

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

Jump to bottom

IBX-6404: Added create bundle extension #2214

Open

juskora wants to merge 7 commits into master from IBX-6404-bundle-extension

Contributor

juskora commented Nov 7, 2023

Question	Answer
JIRA Ticket	https://issues.ibexa.co/browse/IBX-6404
Versions
Edition	all

Checklist

Text renders correctly
Text has been checked with vale
Description metadata is up to date
Redirects cover removed/moved pages
Code samples are working
PHP code samples have been fixed with PHP CS fixer
Added link to this PR in relevant JIRA ticket or code PR


          Added create bundle

87ea868

juskora added the Work in progress label


          Added create bundle

cfcadb0

juskora force-pushed the IBX-6404-bundle-extension branch from 87ea868 to cfcadb0 Compare

November 7, 2023 07:23

adamwojs reviewed

View reviewed changes

docs/administration/project_organization/packages_and_bundles/create_bundle.md Outdated Show resolved Hide resolved

docs/administration/project_organization/packages_and_bundles/create_bundle.md Outdated Show resolved Hide resolved

docs/administration/project_organization/packages_and_bundles/create_bundle.md Outdated Show resolved Hide resolved

docs/administration/project_organization/packages_and_bundles/create_bundle.md Outdated Show resolved Hide resolved

juskora force-pushed the IBX-6404-bundle-extension branch 4 times, most recently from 9f0b169 to a428215 Compare

November 13, 2023 11:11

juskora marked this pull request as ready for review

November 13, 2023 11:56


          Merge branch 'IBX-6404-bundle-extension' of github.com:ibexa/document…

d8d531c

…ation-developer into IBX-6404-bundle-extension

juskora force-pushed the IBX-6404-bundle-extension branch from a428215 to d8d531c Compare

November 15, 2023 11:10


          Added improvements

de176ce

juskora added Needs DEV review and removed Work in progress labels

juskora requested a review from adamwojs

November 16, 2023 08:53

juskora added the Needs DOC review label


          Fixed vale errors

d50747c

julitafalcondusza approved these changes

View reviewed changes

docs/administration/project_organization/bundle_extension/create_bundle.md Outdated Show resolved Hide resolved

MagdalenaZuba suggested changes

View reviewed changes

docs/administration/project_organization/bundle_extension/package_structure.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/create_bundle.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/create_bundle.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/create_bundle.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/create_bundle.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/package_structure.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/package_structure.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/upload_packagist.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/upload_packagist.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/upload_packagist.md Outdated Show resolved Hide resolved


          Apply suggestions from code review

ab3fd85

Co-authored-by: julitafalcondusza <[email protected]>
Co-authored-by: Magdalena Dziadosz <[email protected]>

juskora requested a review from MagdalenaZuba

November 17, 2023 08:02

MagdalenaZuba approved these changes

View reviewed changes

docs/administration/project_organization/bundle_extension/create_bundle.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/create_bundle.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/create_bundle.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/install_package.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/install_package.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/upload_packagist.md Outdated Show resolved Hide resolved

docs/administration/project_organization/bundle_extension/install_package.md Outdated Show resolved Hide resolved


          Apply suggestions from code review

24d2db0

Co-authored-by: Magdalena Dziadosz <[email protected]>

dabrt requested changes

View reviewed changes

docs/administration/project_organization/bundle_extension/create_bundle.md


		# Create bundle

		A bundle is a reusable [[= product_name =]] extension that can be integrated.

Contributor

dabrt Feb 16, 2024

How about...
"Bundles are reusable [==] extensions that can be integrated"?
This would help get rid of the articles.

docs/administration/project_organization/bundle_extension/create_bundle.md

+              # Create bundle
+              A bundle is a reusable [[= product_name =]] extension that can be integrated.
+              To ensure full compatibility, follow the structure specifications described in the

Contributor

dabrt Feb 16, 2024

Suggested change

      
            To ensure full compatibility, follow the structure specifications described in the
          
            When creating your own bundle, to ensure full compatibility, follow the structure specifications described in the

docs/administration/project_organization/bundle_extension/create_bundle.md

+              To ensure full compatibility, follow the structure specifications described in the
+              [package structure](package_structure.md/#package-and-bundle-structure-and-namespaces) section.
+              The bundle extension described here is called `AcmeCurrencyExchangeRate` and enables a new page block which displays a currency exchange rate on your site.

Contributor

dabrt Feb 16, 2024

Suggested change

      
            The bundle extension described here is called `AcmeCurrencyExchangeRate` and enables a new page block which displays a currency exchange rate on your site.
          
            The bundle extension described here is called `AcmeCurrencyExchangeRate` and enables a new page block which displays a currency exchange rate.

docs/administration/project_organization/bundle_extension/create_bundle.md


		The bundle extension described here is called `AcmeCurrencyExchangeRate` and enables a new page block which displays a currency exchange rate on your site.

		You can create a bundle skeleton in two simplified ways:

Contributor

dabrt Feb 16, 2024

Suggested change

      
            You can create a bundle skeleton in two simplified ways:
          
            You can create a bundle skeleton in two ways:

docs/administration/project_organization/bundle_extension/create_bundle.md


		You can create a bundle skeleton in two simplified ways:

		- [using Ibexa bundle generator](#create-bundle-with-bundle-generator)

Contributor

dabrt Feb 16, 2024

Suggested change

      
            - [using Ibexa bundle generator](#create-bundle-with-bundle-generator)
          
            - [with [[= product_name_base =]] bundle generator](#create-bundle-with-bundle-generator)

docs/administration/project_organization/bundle_extension/upload_packagist.md


		![Submit package](packagist_submit.png)

		2\. Provide the repository URL to your package, for example:

Contributor

dabrt Feb 16, 2024

Suggested change

      
            2\. Provide the repository URL to your package, for example:
          
            2\. Provide a URL address of the repository that holds your package, for example:

docs/administration/project_organization/bundle_extension/upload_packagist.md

+              !!! note
+                  When you add a new feature, you need to create a tag.
+\. To create a new tag, in GitHub, go to **Tags** section, and click **Create a new release**.

Contributor

dabrt Feb 16, 2024

Suggested change

      
            3\. To create a new tag, in GitHub, go to **Tags** section, and click **Create a new release**.
          
            3\. To create a new tag, in GitHub, go to **Tags** section, and click **Create a new release**.

docs/administration/project_organization/bundle_extension/upload_packagist.md

+              Make sure the repository is set to public.
+              Each time you add a new feature to your bundle, you need to also add a new tag.
+\. Click the **Check** button to verify the bundle completeness.

Contributor

dabrt Feb 16, 2024

Suggested change

      
            5\. Click the **Check** button to verify the bundle completeness.
          
            5\. Click the **Check** button to verify the completeness of the bundle.

docs/administration/project_organization/bundle_extension/upload_packagist.md


		5\. Click the Check button to verify the bundle completeness.

		In `composer.json` in the `repositories` indicate the type and bundle URL:

Contributor

dabrt Feb 16, 2024

Suggested change

      
            In `composer.json` in the `repositories` indicate the type and bundle URL:
          
            In `composer.json`, under `repositories`, indicate the type and URL address of the bundle:

docs/administration/project_organization/bundle_extension/upload_packagist.md

+                  }
+              ```
+              Any change in repository immediately affects the other bundle so you can see the changes.

Contributor

dabrt Feb 16, 2024

"in the repository"...
What other bundle? It is unclear

juskora removed the Needs DOC review label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs DEV review