Skip to content

Commit b536b09

Browse files
committed
minor #2612 Document src/**/assets/README.md files about direct installation and recommended alternatives. (Kocal)
This PR was squashed before being merged into the 2.x branch. Discussion ---------- Document `src/**/assets/README.md` files about direct installation and recommended alternatives. | Q | A | ------------- | --- | Bug fix? | no | New feature? | no <!-- please update src/**/CHANGELOG.md files --> | Issues | Fix #... <!-- prefix each issue number with "Fix #", no need to create an issue if none exist, explain below instead --> | License | MIT <!-- Replace this notice by a description of your feature/bugfix. This will help reviewers and should be a good start for the documentation. Additionally (see https://symfony.com/releases): - Always add tests and ensure they pass. - For new features, provide some code snippets to help understand usage. - Features and deprecations must be submitted against branch main. - Changelog entry should follow https://symfony.com/doc/current/contributing/code/conventions.html#writing-a-changelog-entry - Never break backward compatibility (see https://symfony.com/bc). --> Follow #2595, related to #2575 Commits ------- 9a4acb1 [CI] Do not run `test` workflow if only `src/**/*.md` files have been modified d49923b Document `src/**/assets/README.md` files about direct installation and recommended alternatives.
2 parents ea891c8 + 9a4acb1 commit b536b09

File tree

19 files changed

+68
-33
lines changed

19 files changed

+68
-33
lines changed

.github/workflows/test.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@ on:
44
push:
55
paths-ignore:
66
- 'src/*/doc/**'
7+
- 'src/**/*.md'
78
- 'ux.symfony.com/**'
89
pull_request:
910
paths-ignore:
1011
- 'src/*/doc/**'
12+
- 'src/**/*.md'
1113
- 'ux.symfony.com/**'
1214

1315
jobs:

.github/workflows/ux.symfony.com.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ on:
66
- 'ux.symfony.com/**'
77
- 'src/*/**'
88
- '!src/*/doc/**'
9+
- '!src/**/*.md'
910
- '.github/**'
1011
pull_request:
1112
paths:
1213
- 'ux.symfony.com/**'
1314
- 'src/*/**'
1415
- '!src/*/doc/**'
16+
- '!src/**/*.md'
1517
- '.github/**'
1618

1719
jobs:

src/Autocomplete/assets/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Javascript-powered auto-completion functionality for your Symfony forms!
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-autocomplete](https://github.com/symfony/ux/tree/2.x/src/Autocomplete).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-autocomplete](https://packagist.org/packages/symfony/ux-autocomplete) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-autocomplete](https://packagist.org/packages/symfony/ux-autocomplete) PHP package version.**
68

79
## Resources
810

src/Chartjs/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Chart.js integration for Symfony.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-chartjs](https://github.com/symfony/ux/tree/2.x/src/Chartjs).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-chartjs](https://packagist.org/packages/symfony/ux-chartjs) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-chartjs](https://packagist.org/packages/symfony/ux-chartjs) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-chartjs/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/Cropperjs/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Cropper.js integration for Symfony.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-cropperjs](https://github.com/symfony/ux/tree/2.x/src/Cropperjs).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-cropperjs](https://packagist.org/packages/symfony/ux-cropperjs) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-cropperjs](https://packagist.org/packages/symfony/ux-cropperjs) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-cropperjs/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/Dropzone/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
File input dropzones for Symfony Forms.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-dropzone](https://github.com/symfony/ux/tree/2.x/src/Dropzone).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-dropzone](https://packagist.org/packages/symfony/ux-dropzone) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-dropzone](https://packagist.org/packages/symfony/ux-dropzone) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-dropzone/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/LazyImage/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Lazy image loader and utilities for Symfony.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-lazy-image](https://github.com/symfony/ux/tree/2.x/src/LazyImage).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-lazy-image](https://packagist.org/packages/symfony/ux-lazy-image) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-lazy-image](https://packagist.org/packages/symfony/ux-lazy-image) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-lazy-image/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/LiveComponent/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Live Component: bring server-side re-rendering & model binding to any element.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-live-component](https://github.com/symfony/ux/tree/2.x/src/LiveComponent).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-live-component](https://packagist.org/packages/symfony/ux-live-component) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-live-component](https://packagist.org/packages/symfony/ux-live-component) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-live-component/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/Map/assets/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
Easily embed interactive maps in your Symfony application.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-map](https://github.com/symfony/ux/tree/2.x/src/Map).**
6-
75
## Resources
86

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
7+
- [Documentation](https://symfony.com/bundles/ux-map/current/index.html)
108
- [Report issues](https://github.com/symfony/ux/issues) and
119
[send Pull Requests](https://github.com/symfony/ux/pulls)
1210
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/Notify/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Native notification integration for Symfony using Mercure.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-notify](https://github.com/symfony/ux/tree/2.x/src/Notify).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-notify](https://packagist.org/packages/symfony/ux-notify) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-notify](https://packagist.org/packages/symfony/ux-notify) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-notify/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/React/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Integration of React in Symfony.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-react](https://github.com/symfony/ux/tree/2.x/src/React).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-react](https://packagist.org/packages/symfony/ux-react) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-react](https://packagist.org/packages/symfony/ux-react) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-react/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/StimulusBundle/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Integration of @hotwired/stimulus into Symfony.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-stimulus-bundle](https://github.com/symfony/ux/tree/2.x/src/StimulusBundle).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/stimulus-bundle](https://packagist.org/packages/symfony/stimulus-bundle) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/stimulus-bundle](https://packagist.org/packages/symfony/stimulus-bundle) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/StimulusBundle/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/Svelte/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Integration of Svelte in Symfony.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-svelte](https://github.com/symfony/ux/tree/2.x/src/Svelte).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-svelte](https://packagist.org/packages/symfony/ux-svelte) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-svelte](https://packagist.org/packages/symfony/ux-svelte) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-svelte/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/Swup/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Swup integration for Symfony.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-swup](https://github.com/symfony/ux/tree/2.x/src/Swup).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-swup](https://packagist.org/packages/symfony/ux-swup) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-swup](https://packagist.org/packages/symfony/ux-swup) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-swup/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/TogglePassword/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Toggle visibility of password inputs for Symfony Forms.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-toggle-password](https://github.com/symfony/ux/tree/2.x/src/TogglePassword).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-toggle-password](https://packagist.org/packages/symfony/ux-toggle-password) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-toggle-password](https://packagist.org/packages/symfony/ux-toggle-password) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-toggle-password/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/Translator/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Symfony Translator for JavaScript.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-translator](https://github.com/symfony/ux/tree/2.x/src/Translator).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-translator](https://packagist.org/packages/symfony/ux-translator) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-translator](https://packagist.org/packages/symfony/ux-translator) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-translator/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/Turbo/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Hotwire Turbo integration for Symfony.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-turbo](https://github.com/symfony/ux/tree/2.x/src/Turbo).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-turbo](https://packagist.org/packages/symfony/ux-turbo) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-turbo](https://packagist.org/packages/symfony/ux-turbo) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-turbo/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/Typed/assets/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@
33
Typed integration for Symfony.
44

55
**This package can't be used on its own, and requires the PHP package [symfony/ux-typed](https://github.com/symfony/ux/tree/2.x/src/Typed).**
6+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-typed](https://packagist.org/packages/symfony/ux-typed) in a Symfony application with Flex enabled.
7+
8+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-typed](https://packagist.org/packages/symfony/ux-typed) PHP package version.**
69

710
## Resources
811

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
12+
- [Documentation](https://symfony.com/bundles/ux-typed/current/index.html)
1013
- [Report issues](https://github.com/symfony/ux/issues) and
1114
[send Pull Requests](https://github.com/symfony/ux/pulls)
1215
in the [main Symfony UX repository](https://github.com/symfony/ux)

src/Vue/assets/README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Integration of Vue.js in Symfony.
44

5-
**This package can't be used on its own, and requires the PHP package [symfony/ux-vue](https://github.com/symfony/ux/tree/2.x/src/Vue).**
5+
**ℹ️ Direct installation of this package is for advanced users only.** We strongly recommend installing it through the PHP package [symfony/ux-vue](https://packagist.org/packages/symfony/ux-vue) in a Symfony application with Flex enabled.
6+
7+
If you still want to install this package directly, **make sure its version exactly matches [symfony/ux-vue](https://packagist.org/packages/symfony/ux-vue) PHP package version.**
68

79
## Resources
810

9-
- [Documentation](https://symfony.com/bundles/ux-autocomplete/current/index.html)
11+
- [Documentation](https://symfony.com/bundles/ux-vue/current/index.html)
1012
- [Report issues](https://github.com/symfony/ux/issues) and
1113
[send Pull Requests](https://github.com/symfony/ux/pulls)
1214
in the [main Symfony UX repository](https://github.com/symfony/ux)

0 commit comments

Comments
 (0)