From e4cf61de19ae7475af816f2e80e7cc3bc9a5c84a Mon Sep 17 00:00:00 2001 From: Shivangi Shree Date: Tue, 4 Aug 2026 11:03:50 +0530 Subject: [PATCH] [ACS-12322] Update docs --- .github/actions/before-e2e/action.yml | 2 +- .github/workflows/e2e-playwright-reusable.yml | 10 +++++----- README.md | 7 ++++--- docs/extending/redistributable-libraries.md | 8 ++++---- docs/getting-started/docker.md | 2 +- docs/getting-started/using-local-adf.md | 2 +- docs/getting-started/windows.md | 4 ++-- docs/tutorials/how-to-create-your-first-extension.md | 10 +++++----- docs/upgrade-guide/upgrade211-30.md | 12 ++++++------ 9 files changed, 29 insertions(+), 28 deletions(-) diff --git a/.github/actions/before-e2e/action.yml b/.github/actions/before-e2e/action.yml index 83daf3550..c537b20e5 100644 --- a/.github/actions/before-e2e/action.yml +++ b/.github/actions/before-e2e/action.yml @@ -6,4 +6,4 @@ runs: steps: - name: Check content UP shell: bash - run: pnpm run ci:check-env || exit 1 + run: pnpm ci:check-env || exit 1 diff --git a/.github/workflows/e2e-playwright-reusable.yml b/.github/workflows/e2e-playwright-reusable.yml index 41bb500a2..6d447f55b 100644 --- a/.github/workflows/e2e-playwright-reusable.yml +++ b/.github/workflows/e2e-playwright-reusable.yml @@ -42,15 +42,15 @@ jobs: fetch-depth: 2 - uses: ./.github/actions/before-install - - run: npm ci + - run: pnpm install --frozen-lockfile - name: upload npm logs uses: actions/upload-artifact@v7 if: failure() with: name: npm-logs path: /home/runner/.npm/_logs/ - - run: npm run ci:build -- aca-playwright-shared - - run: npm run build -- $BUILD_OPTS + - run: pnpm ci:build -- aca-playwright-shared + - run: pnpm build -- $BUILD_OPTS - name: dist cache if: ${{ success() }} @@ -139,7 +139,7 @@ jobs: uses: ./.github/actions/before-install - name: Install dependencies - run: npm ci + run: pnpm install --frozen-lockfile - name: Restore dist cache uses: actions/cache/restore@v6 @@ -153,7 +153,7 @@ jobs: - name: Check Search Indexing continue-on-error: true - run: npm run ci:check-search-indexing + run: pnpm ci:check-search-indexing env: ADMIN_PASSWORD_SCRIPT: ${{ env.ADMIN_PASSWORD }} diff --git a/README.md b/README.md index 58864fedf..72170b7bd 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,8 @@ Please refer to the public [documentation](https://alfresco-content-app.netlify. | Name | Version | |---------|---------| | Node.js | 24.x | -| Npm | 11.x | +| Npm | 11.x | +| Pnpm | 11.x | ## Compatibility @@ -48,8 +49,8 @@ Where `` is the address of the ACS. Run the following commands: ```sh -npm install -npm start +pnpm install +pnpm start ``` ## Unit Tests diff --git a/docs/extending/redistributable-libraries.md b/docs/extending/redistributable-libraries.md index 140da4161..af1954857 100644 --- a/docs/extending/redistributable-libraries.md +++ b/docs/extending/redistributable-libraries.md @@ -119,14 +119,14 @@ Be sure to mention that developers should have a build rule to copy your plugin Before you publish you should always rebuild the library: ```sh -npm run build:my-extension +pnpm build:my-extension ``` Go to the output folder and run the publish command. ```sh cd dist/my-extension -npm publish +pnpm publish ``` Note, you are required to have a valid [NPM](https://www.npmjs.com/) account. @@ -138,7 +138,7 @@ See more details in the [Publishing your library](https://github.com/angular/ang Assuming you have published your extension library to NPM, you can install it using the standard command: ```sh -npm install my-extension +pnpm add my-extension ``` This installs the library and all its dependencies. @@ -199,7 +199,7 @@ Finally, update the `src/assets/app.extensions.json` file and add a reference to Run the application and ensure you have an extra navigation sidebar entry: ```sh -npm start +pnpm start ``` Click the `My Extension` link and in the main content area you will see the extension component coming from your library. diff --git a/docs/getting-started/docker.md b/docs/getting-started/docker.md index e4525c159..02e9cbeeb 100644 --- a/docs/getting-started/docker.md +++ b/docs/getting-started/docker.md @@ -3,7 +3,7 @@ Running local build with Docker ```shell -npm run build +pnpm run build ``` The application is already preconfigured to run alongside backend containers within the Docker Compose. diff --git a/docs/getting-started/using-local-adf.md b/docs/getting-started/using-local-adf.md index 4f244e3d4..5004c2bc6 100644 --- a/docs/getting-started/using-local-adf.md +++ b/docs/getting-started/using-local-adf.md @@ -5,7 +5,7 @@ If you are working with ADF source code and want to use the modified version wit Clone the `alfresco-ng2-components` and `alfresco-content-app` repositories in the same folder, and run the following command: ```sh -npm start -- --configuration=adf +pnpm start --configuration=adf ``` Changing the ADF code results in the recompilation and hot-reloading of the ACA application. diff --git a/docs/getting-started/windows.md b/docs/getting-started/windows.md index d557fe06f..d5db16328 100644 --- a/docs/getting-started/windows.md +++ b/docs/getting-started/windows.md @@ -68,8 +68,8 @@ npm install -g @nrwl/cli In the VS Code Terminal (powershell), run the following: ```sh -npm install -npm start +pnpm install +pnpm start ``` The application should open at `http://localhost:4200` by default. diff --git a/docs/tutorials/how-to-create-your-first-extension.md b/docs/tutorials/how-to-create-your-first-extension.md index cdf9d9b2f..6db65f0cf 100644 --- a/docs/tutorials/how-to-create-your-first-extension.md +++ b/docs/tutorials/how-to-create-your-first-extension.md @@ -17,10 +17,10 @@ First create a folder where you would like to place the extensions. i.e. `/exten Then run the `@nx/angular` library generator using the following command as a template: ```console -npx nx generate @nx/angular:library --name=@myorg/my-extension --buildable=true --directory=extensions/myextension --publishable=true --importPath=@myorg/my-extension --projectNameAndRootFormat=as-provided --no-interactive +pnpm exec nx generate @nx/angular:library --name=@myorg/my-extension --buildable=true --directory=extensions/myextension --publishable=true --importPath=@myorg/my-extension --projectNameAndRootFormat=as-provided --no-interactive ``` -where `name` is the name of the library, `directory` is a directory where the library is placed and `importPath` is the library name used for the import, like `@myorg/my-awesome-lib`. This must be a valid npm package name. +where `name` is the name of the library, `directory` is a directory where the library is placed and `importPath` is the library name used for the import, like `@myorg/my-awesome-lib`. This must be a valid pnpm package name. See the official [Nx Angular library](https://nx.dev/nx-api/angular/generators/library) documentation for more details. @@ -38,7 +38,7 @@ Next to validate the changed verify the following: } ``` -- Test if npm i is working: +- Test if pnpm install is working: # Developing the basics of the ACA extension @@ -161,13 +161,13 @@ Last but not least, edit the package.json file to allow the build of the extensi Once done, create the build of the extension running the following command. - npm install my-extension + pnpm add my-extension # Running ACA with the extension included Now that everything is properly developed, it’s time to launch ADW and see the result. To launch ADW, run the following command from a terminal. - npm start + pnpm start What you should see is a new item in left menu of the landing page for ACA, implementing the route to a new page with the following content. Below the screenshot describing what it should look like. diff --git a/docs/upgrade-guide/upgrade211-30.md b/docs/upgrade-guide/upgrade211-30.md index b48fb45c8..9c71ed3ab 100644 --- a/docs/upgrade-guide/upgrade211-30.md +++ b/docs/upgrade-guide/upgrade211-30.md @@ -46,12 +46,12 @@ After Replace: ``` 2. Install your dependencies ```sh -npm i +pnpm i ``` 3. Run the application ```sh -npm start +pnpm start ``` **Note:** The compiler gives errors and complains about adf libraries with ‘has no exported member’ errors. You can find many errors with different adf libraries. @@ -98,15 +98,15 @@ Error 2: You need to update the datetimepicker dependencies. ```sh -npm install --save @mat-datetimepicker/core@9 -npm install --save @mat-datetimepicker/moment@9 +pnpm add @mat-datetimepicker/core@9 +pnpm add @mat-datetimepicker/moment@9 ``` Make sure you have installed dev dependency for the below dependencies ```sh -npm install --save-dev inquirer@^8.0.0 -npm install --save-dev winston@^3.8.2 +pnpm add -D inquirer@^8.0.0 +pnpm add -D winston@^3.8.2 ``` BREAKING CHANGE: webpack < 5 used to include polyfills for node.js core modules by default.