Skip to content

Commit

Permalink
Fixed documentation to be pnpm run plugins i for plugin installation
Browse files Browse the repository at this point in the history
  • Loading branch information
SamTV12345 committed May 24, 2024
1 parent 966b0dc commit 6679d43
Show file tree
Hide file tree
Showing 7 changed files with 4,810 additions and 3,795 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/upgrade-from-latest-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ jobs:
-
name: Install Etherpad plugins
run: >
pnpm run install-plugins
pnpm run plugins i
ep_align
ep_author_hover
ep_cursortrace
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@
- Bin folder: The bin folder has been moved from the src folder to the root folder. This change was necessary as the contained scripts do not represent core functionality of the user.
- Starting Etherpad: Etherpad can now be started with a single command: `pnpm run prod` in the root directory.
- Installing Etherpad: Etherpad no longer symlinks itself in the root directory. This is now also taken care by pnpm, and it just creates a node_modules folder with the src directory`s ep_etherpad-lite folder
- Plugins can now be installed simply via the command: `pnpm run install-plugins first-plugin second-plugin` or if you want to install from path you can do:
`pnpm run install-plugins --path ../path-to-plugin`
- Plugins can now be installed simply via the command: `pnpm run plugins i first-plugin second-plugin` or if you want to install from path you can do:
`pnpm run plugins i --path ../path-to-plugin`


# 1.9.7
Expand Down
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ COPY --chown=etherpad:etherpad --from=adminBuild /opt/etherpad-lite/ui/dist ./sr

RUN bin/installDeps.sh && \
if [ ! -z "${ETHERPAD_PLUGINS}" ] || [ ! -z "${ETHERPAD_LOCAL_PLUGINS}" ]; then \
pnpm run install-plugins ${ETHERPAD_PLUGINS} ${ETHERPAD_LOCAL_PLUGINS:+--path ${ETHERPAD_LOCAL_PLUGINS}}; \
pnpm run plugins i ${ETHERPAD_PLUGINS} ${ETHERPAD_LOCAL_PLUGINS:+--path ${ETHERPAD_LOCAL_PLUGINS}}; \
fi


Expand All @@ -135,7 +135,7 @@ COPY --chown=etherpad:etherpad --from=adminBuild /opt/etherpad-lite/ui/dist ./sr

RUN bin/installDeps.sh && rm -rf ~/.npm && rm -rf ~/.local && rm -rf ~/.cache && \
if [ ! -z "${ETHERPAD_PLUGINS}" ] || [ ! -z "${ETHERPAD_LOCAL_PLUGINS}" ]; then \
pnpm run install-plugins ${ETHERPAD_PLUGINS} ${ETHERPAD_LOCAL_PLUGINS:+--path ${ETHERPAD_LOCAL_PLUGINS}}; \
pnpm run plugins i ${ETHERPAD_PLUGINS} ${ETHERPAD_LOCAL_PLUGINS:+--path ${ETHERPAD_LOCAL_PLUGINS}}; \
fi


Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ Alternatively, you can install plugins from the command line:

```sh
cd /path/to/etherpad-lite
pnpm run install-plugins ep_${plugin_name}
pnpm run plugins i ep_${plugin_name}
```

Also see [the plugin wiki
Expand All @@ -207,7 +207,7 @@ Run the following command in your Etherpad folder to get all of the features
visible in the above demo gif:

```sh
pnpm run install-plugins \
pnpm run plugins i \
ep_align \
ep_comments_page \
ep_embedded_hyperlinks2 \
Expand Down
2 changes: 1 addition & 1 deletion bin/plugins/lib/backend-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ jobs:
working-directory: ./etherpad-lite
run: |
pnpm link --global $PLUGIN_NAME
pnpm run install-plugins --path ../../plugin
pnpm run plugins i --path ../../plugin
env:
PLUGIN_NAME: ${{ steps.plugin_name.outputs.plugin_name }}
- name: Link ep_etherpad-lite
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"test-ui:ui": "pnpm --filter ep_etherpad-lite run test-ui:ui",
"test-admin": "pnpm --filter ep_etherpad-lite run test-admin",
"test-admin:ui": "pnpm --filter ep_etherpad-lite run test-admin:ui",
"install-plugins": "pnpm --filter bin run install-plugins",
"plugins": "pnpm --filter bin run plugins",
"remove-plugins": "pnpm --filter bin run remove-plugins",
"list-plugins": "pnpm --filter bin run list-plugins"
},
Expand Down

0 comments on commit 6679d43

Please sign in to comment.