From 2b4f934ff8414838f0e1deb0d56039cc64c2929a Mon Sep 17 00:00:00 2001 From: Grzegorz Ferenc <41291385+greg-fer@users.noreply.github.com> Date: Mon, 18 Dec 2023 16:33:37 +0100 Subject: [PATCH] doc: align folder structure (#61) * doc: align folder structure Moved doc files into a new structure. Edited workflow files accordingly. Signed-off-by: Grzegorz Ferenc * Feat: update shared * update zoomin python script Signed-off-by: Grzegorz Ferenc --------- Signed-off-by: Grzegorz Ferenc Co-authored-by: Kyle Micallef Bonnici --- .github/workflows/zoomin-publish-dev.yml | 2 +- .github/workflows/zoomin.yml | 13 ++++++------- {docs => doc/docs}/configuration.md | 0 {docs => doc/docs}/configuring_serial_port.md | 0 {docs => doc/docs}/getting_started.md | 0 {docs => doc/docs}/index.md | 0 {docs => doc/docs}/installing.md | 0 {docs => doc/docs}/revision_history.md | 0 .../screenshots/serial_term_select_device.png | Bin .../docs}/screenshots/serial_term_serial_ports.png | Bin {docs => doc/docs}/selecting_serial_port.md | 0 {docs => doc/docs}/troubleshooting.md | 0 mkdocs.yml => doc/mkdocs.yml | 0 custom.properties => doc/zoomin/custom.properties | 0 tags.yml => doc/zoomin/tags.yml | 0 package-lock.json | 12 ++++++------ package.json | 2 +- 17 files changed, 14 insertions(+), 15 deletions(-) rename {docs => doc/docs}/configuration.md (100%) rename {docs => doc/docs}/configuring_serial_port.md (100%) rename {docs => doc/docs}/getting_started.md (100%) rename {docs => doc/docs}/index.md (100%) rename {docs => doc/docs}/installing.md (100%) rename {docs => doc/docs}/revision_history.md (100%) rename {docs => doc/docs}/screenshots/serial_term_select_device.png (100%) rename {docs => doc/docs}/screenshots/serial_term_serial_ports.png (100%) rename {docs => doc/docs}/selecting_serial_port.md (100%) rename {docs => doc/docs}/troubleshooting.md (100%) rename mkdocs.yml => doc/mkdocs.yml (100%) rename custom.properties => doc/zoomin/custom.properties (100%) rename tags.yml => doc/zoomin/tags.yml (100%) diff --git a/.github/workflows/zoomin-publish-dev.yml b/.github/workflows/zoomin-publish-dev.yml index b8815b8..cde7eec 100644 --- a/.github/workflows/zoomin-publish-dev.yml +++ b/.github/workflows/zoomin-publish-dev.yml @@ -5,7 +5,7 @@ on: branches: - main paths: - - docs + - doc/docs workflow_dispatch: jobs: diff --git a/.github/workflows/zoomin.yml b/.github/workflows/zoomin.yml index a667905..3b56da7 100644 --- a/.github/workflows/zoomin.yml +++ b/.github/workflows/zoomin.yml @@ -16,16 +16,15 @@ jobs: - uses: actions/checkout@v3 - name: Copy zoomin properties - run: cp docs/zoomin/* . - - - name: Replace index.md - run: cp docs/zoomin/index.md docs/index.md + run: | + cp doc/zoomin/custom.properties doc/ \ + && cp doc/zoomin/tags.yml doc/ - name: Create zip file run: | - zip -r nrf-connect-serial-terminal.zip \ - docs mkdocs.yml custom.properties tags.yml \ - -x@docs/zoomin/ignore.txt + cd doc/ \ + && zip -r ../nrf-connect-serial-terminal.zip \ + docs/* mkdocs.yml custom.properties tags.yml - name: Upload documentation artifact uses: actions/upload-artifact@v3 diff --git a/docs/configuration.md b/doc/docs/configuration.md similarity index 100% rename from docs/configuration.md rename to doc/docs/configuration.md diff --git a/docs/configuring_serial_port.md b/doc/docs/configuring_serial_port.md similarity index 100% rename from docs/configuring_serial_port.md rename to doc/docs/configuring_serial_port.md diff --git a/docs/getting_started.md b/doc/docs/getting_started.md similarity index 100% rename from docs/getting_started.md rename to doc/docs/getting_started.md diff --git a/docs/index.md b/doc/docs/index.md similarity index 100% rename from docs/index.md rename to doc/docs/index.md diff --git a/docs/installing.md b/doc/docs/installing.md similarity index 100% rename from docs/installing.md rename to doc/docs/installing.md diff --git a/docs/revision_history.md b/doc/docs/revision_history.md similarity index 100% rename from docs/revision_history.md rename to doc/docs/revision_history.md diff --git a/docs/screenshots/serial_term_select_device.png b/doc/docs/screenshots/serial_term_select_device.png similarity index 100% rename from docs/screenshots/serial_term_select_device.png rename to doc/docs/screenshots/serial_term_select_device.png diff --git a/docs/screenshots/serial_term_serial_ports.png b/doc/docs/screenshots/serial_term_serial_ports.png similarity index 100% rename from docs/screenshots/serial_term_serial_ports.png rename to doc/docs/screenshots/serial_term_serial_ports.png diff --git a/docs/selecting_serial_port.md b/doc/docs/selecting_serial_port.md similarity index 100% rename from docs/selecting_serial_port.md rename to doc/docs/selecting_serial_port.md diff --git a/docs/troubleshooting.md b/doc/docs/troubleshooting.md similarity index 100% rename from docs/troubleshooting.md rename to doc/docs/troubleshooting.md diff --git a/mkdocs.yml b/doc/mkdocs.yml similarity index 100% rename from mkdocs.yml rename to doc/mkdocs.yml diff --git a/custom.properties b/doc/zoomin/custom.properties similarity index 100% rename from custom.properties rename to doc/zoomin/custom.properties diff --git a/tags.yml b/doc/zoomin/tags.yml similarity index 100% rename from tags.yml rename to doc/zoomin/tags.yml diff --git a/package-lock.json b/package-lock.json index 6c05f0e..90a3ce5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,15 +1,15 @@ { "name": "pc-nrfconnect-serial-terminal", - "version": "1.2.0", + "version": "1.2.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "pc-nrfconnect-serial-terminal", - "version": "1.2.0", + "version": "1.2.1", "license": "SEE LICENSE IN LICENSE", "devDependencies": { - "@nordicsemiconductor/pc-nrfconnect-shared": "^142.0.0", + "@nordicsemiconductor/pc-nrfconnect-shared": "^143.0.0", "ansi-escapes": "^4.3.2", "serialport": "^10.5.0", "xterm-addon-fit": "^0.8.0", @@ -2834,9 +2834,9 @@ } }, "node_modules/@nordicsemiconductor/pc-nrfconnect-shared": { - "version": "142.0.0", - "resolved": "https://registry.npmjs.org/@nordicsemiconductor/pc-nrfconnect-shared/-/pc-nrfconnect-shared-142.0.0.tgz", - "integrity": "sha512-dz0sWMUje+VYzvPPaX4gEhswAHEt+MCNTRkzP1SEQ7SYVV5/hAQIlBKeLIuUzLYXmRldTjZ7j91j+G8GSps1aw==", + "version": "143.0.0", + "resolved": "https://registry.npmjs.org/@nordicsemiconductor/pc-nrfconnect-shared/-/pc-nrfconnect-shared-143.0.0.tgz", + "integrity": "sha512-r/cAKvq6ErLSbd5OBfPqgVjVvzqjYhBI8F0IN/E84b1fVFLJBsGnhs9OdsLA1NJtIGpmJKCoX153NfwccJ0TPA==", "dev": true, "hasInstallScript": true, "dependencies": { diff --git a/package.json b/package.json index 0b30148..924e8cc 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,7 @@ "prepare": "husky install" }, "devDependencies": { - "@nordicsemiconductor/pc-nrfconnect-shared": "^142.0.0", + "@nordicsemiconductor/pc-nrfconnect-shared": "^143.0.0", "ansi-escapes": "^4.3.2", "serialport": "^10.5.0", "xterm-addon-fit": "^0.8.0",