From be325469df91e2e367c2f8e09c672363d56c852a Mon Sep 17 00:00:00 2001 From: Milo Schwartz Date: Tue, 21 Jan 2025 16:21:46 -0500 Subject: [PATCH] add yaml to how to update, and change branch in contributing --- .../02-Getting Started/06-how-to-update.md | 19 ++++++++++++++++--- packages/docusaurus/docs/08-development.md | 4 +++- 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/packages/docusaurus/docs/02-Getting Started/06-how-to-update.md b/packages/docusaurus/docs/02-Getting Started/06-how-to-update.md index 8956773..f352af0 100644 --- a/packages/docusaurus/docs/02-Getting Started/06-how-to-update.md +++ b/packages/docusaurus/docs/02-Getting Started/06-how-to-update.md @@ -10,19 +10,32 @@ Some basic commands to get you started: sudo docker compose down ``` -2. Pull the latest images +2. Update the docker compose file with the new version number + +```yaml +services: + pangolin: + image: fosrl/pangolin:1.0.0-beta.8 # increase the tag to the latest version number, or use "latest" + container_name: pangolin + restart: unless-stopped +... +``` + +Do this for each container you want to update. + +3. Pull the latest images ```bash sudo docker compose pull ``` -3. Start the stack +4. Start the stack ```bash sudo docker compose up -d ``` -4. Check the logs +5. Check the logs ```bash sudo docker compose logs -f diff --git a/packages/docusaurus/docs/08-development.md b/packages/docusaurus/docs/08-development.md index c338bd7..2900282 100644 --- a/packages/docusaurus/docs/08-development.md +++ b/packages/docusaurus/docs/08-development.md @@ -34,7 +34,7 @@ Below is an example if you're working on the Pangolin repo. 3. Create a new branch: ```bash - git checkout -b BRANCH_NAME dev + git checkout -b BRANCH_NAME main ``` - It is recommended to give your branch a meaningful name, relevant to the feature or fix you are working on. @@ -49,6 +49,8 @@ Below is an example if you're working on the Pangolin repo. - `fix` - `patch` +4. If you open a pull request, open it against the `main` branch of the original repository. + ## Pangolin - NodeJS v20.10.0