Skip to content

Commit 3f9b9c6

Browse files
committed
Updating Front-end dev docs to reflect change to Astro (updating the ICL for Accelerator Projects)
1 parent 9ee9b21 commit 3f9b9c6

2 files changed

Lines changed: 29 additions & 8 deletions

File tree

docs/accelerator/06-icl.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,31 @@ The ICL directly influences Accelerator project structure and provides the found
2020

2121
- **Header Configuration**: Site Options reference ICL Header Types (Full vs Hybrid)
2222
- **Component Sync**: ICL components are manually synced to both [Drupal Accelerator](https://dev-idfive-drupal-accelerator.pantheonsite.io/) and [WordPress Accelerator](https://dev-idfive-accelerator.pantheonsite.io/) sites
23-
- **Pattern Library**: All Accelerator components follow ICL design patterns established in the [Pattern Lab environment](/docs/front-end/idfive-component-library)
24-
- **Wireframe Foundation**: Project wireframes are built using ICL components
23+
- **Pattern Library**: All Accelerator components follow ICL design markup
2524
- **Consistency Standards**: Ensures all projects maintain idfive design standards
2625

26+
## Updating the ICL in Accelerator Projects
27+
To update an Accelerator Project to the latest version of the ICL:
28+
- [Download the latest tagged version as a zip file](https://bitbucket.org/idfivellc/idfive-component-library/downloads/?tab=tags) from Bitbucket and unzip
29+
- Replace the current ICL in Accelerator with this download:
30+
- In Drupal, this is at `/idfive-drupal-accelerator/web/themes/custom/idfive_accelerator/idfive-component-library`
31+
- In WordPress, this is at `/idfive-accelerator/wp-content/themes/idfive-rapid-starter/idfive-component-library`
32+
- Update the `package.json` file to add in the CMS being used in `"front-end-usage-intent": "",`
33+
- In Drupal
34+
- `package.json` is at `/idfive-drupal-accelerator/web/themes/custom/idfive_accelerator/idfive-component-library/package.json`
35+
- Update `front-end-usage-intent` to `"front-end-usage-intent": "drupal",` (case-sensitive, should be all lower case)
36+
- Open terminal at `/idfive-drupal-accelerator/web/themes/custom/idfive_accelerator/idfive-component-library/`
37+
- Run `nvm use`
38+
- Run `npm install`
39+
- Run `npm run build`
40+
- In Wordpress
41+
- `package.json` is at `/idfive-accelerator/wp-content/themes/idfive-rapid-starter/idfive-component-library/package.json`
42+
- Update `front-end-usage-intent` to `"front-end-usage-intent": "wordpress",` (case-sensitive, should be all lower case)
43+
- Open terminal at `/idfive-accelerator/wp-content/themes/idfive-rapid-starter/idfive-component-library/`
44+
- Run `nvm use`
45+
- Run `npm install`
46+
- Run `npm run build`
47+
2748
## Key Components in Accelerator
2849

2950
### Header Types
@@ -48,12 +69,12 @@ The ICL directly influences Accelerator project structure and provides the found
4869

4970
## Technical Implementation
5071

51-
The ICL is built using modern frontend tools and is available as a Pattern Lab environment. For developers working with Accelerator projects:
72+
The ICL is built using the [Astro](https://astro.build/) static site generator framework. For developers working with Accelerator projects:
5273

53-
- **Pattern Lab Interface**: View all components in isolation and in page context
54-
- **Build System**: Uses Vite/PostCSS (v2+) or SCSS (v1) depending on version
55-
- **Component Library**: TypeScript modules with accessibility utilities
56-
- **Staging Environment**: Available at [staging site](https://staging2.idfive.com/idfive-pattern-lab-starter/public/?p=pages-welcome) (username/password: `guest`)
74+
- **ICL Pages and Component list Interface**: View all components in isolation and in page context
75+
- **Build System**: Uses Astro
76+
- **Component Library**: Modular components
77+
- **Demo Site**: Available at the [netlify ICL site](https://idfive-component-library.netlify.app/) (password: `guest`)
5778

5879
For complete setup instructions, build process, and component documentation, see **[ICL Technical Documentation](/docs/front-end/idfive-component-library)**.
5980

docs/front-end/01-idfive-component-library.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Overview of Front-end Library
55
import Tabs from "@theme/Tabs";
66
import TabItem from "@theme/TabItem";
77

8-
# ICL (idfive Component Library)
8+
# idfive Component Library (ICL)
99

1010
**A collection of components to be used to begin new front-end development projects.** This library is synced-up manually to the [Drupal Accelerator](https://dev-idfive-drupal-accelerator.pantheonsite.io/) and to the [Wordpress Accelerator](https://dev-idfive-accelerator.pantheonsite.io/) sites.
1111

0 commit comments

Comments
 (0)