Skip to content

Commit

Permalink
Closes #3597: Add lifecycle_link to experimental modules documentatio…
Browse files Browse the repository at this point in the history
…n in experimental modules. (#3598)

* Closes #3597: Add lifecycle_link to experimental modules documentation in experimental modules.
Co-authored-by: Chris Green <[email protected]>
Co-authored-by: Brian Berndt <[email protected]>
  • Loading branch information
joeparsons committed Aug 9, 2024
1 parent d62c80f commit b68817d
Show file tree
Hide file tree
Showing 19 changed files with 22 additions and 2 deletions.
6 changes: 4 additions & 2 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,10 @@ creation of the feature.
production sites without thorough testing.

### Classifying Modules as Experimental
To add a module as experimental, define the `package` as
`'The University of Arizona - Experimental'` in the module's `info.yml` file.
To classify a module as experimental, define the following properties in the module's `.info.yml` file:
- `package`: `'The University of Arizona - Experimental'`
- `lifecycle`: `experimental`
- `lifecycle_link`: `'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'`

### Transition Plan for Experimental Modules

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ core_version_requirement: ^9 || ^10
type: module
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- az_core:az_core
- migrate:migrate
Expand Down
1 change: 1 addition & 0 deletions modules/custom/az_course/az_course.info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'Imports courses from the UAccess schedule of classes service.'
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- auto_entitylabel
- field
Expand Down
1 change: 1 addition & 0 deletions modules/custom/az_curated_views/az_curated_views.info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ core_version_requirement: ^9 || ^10
type: module
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- drupal:views
- draggableviews:draggableviews
1 change: 1 addition & 0 deletions modules/custom/az_demo/az_demo.info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'WARNING:Do not enable this on live/production sites, it will alter
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- az_custom_menu_block
- az_core
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'The connector for the centralized University of Arizona Digital As
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- ib_dam:ib_dam
- ib_dam:ib_dam_media
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'Import events from <a href="https://trellis.arizona.edu/solutions/
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
php: 8.0

dependencies:
Expand Down
1 change: 1 addition & 0 deletions modules/custom/az_finder/az_finder.info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'A collection of plugins for building finder style views on Quickst
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- better_exposed_filters:better_exposed_filters
configure: az_finder.settings
1 change: 1 addition & 0 deletions modules/custom/az_http/az_http.info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ description: 'Provides a cache-friendly HTTP service for dedicated API Requests'
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- az_core
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ core_version_requirement: ^9 || ^10
type: module
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- az_news
- az_event
1 change: 1 addition & 0 deletions modules/custom/az_migration/az_migration.info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ core_version_requirement: ^9 || ^10
type: module
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- drupal:migrate
- drupal:migrate_plus
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'Provides a REST export for the Quickstart News content type.'
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- 'az_core:az_core'
- 'az_news:az_news'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'Import news stories from UArizona News.'
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- az_core
- az_news
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ type: module
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
description: 'Provides structured content for a group of links, which come with a handful of style options.'
dependencies:
- field
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ name: 'Quickstart Paragraphs - Views Side-by-Side'
type: module
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
description: 'Provides a paragraph type to show two views side-by-side on desktop screens.'
core_version_requirement: ^9 || ^10
dependencies:
Expand Down
1 change: 1 addition & 0 deletions modules/custom/az_publication/az_publication.info.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ core_version_requirement: ^9 || ^10
type: module
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- 'auto_entitylabel:auto_entitylabel'
- 'az_core:az_core'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'Allows BibTeX import of publications'
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- 'az_core:az_core'
- 'az_publication:az_publication'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'Allows DOI import of publications'
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- 'az_core:az_core'
- 'az_publication:az_publication'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: 'Allows import of publications'
core_version_requirement: ^9 || ^10
package: 'The University of Arizona - Experimental'
lifecycle: experimental
lifecycle_link: 'https://github.com/az-digital/az_quickstart/blob/main/RELEASES.md#experimental-features'
dependencies:
- 'az_core:az_core'
- 'az_publication:az_publication'
Expand Down

0 comments on commit b68817d

Please sign in to comment.