From c8db893aa60a3825f591c553e94475c08b07d396 Mon Sep 17 00:00:00 2001 From: Evan Buss Date: Sun, 5 May 2024 21:11:00 +0000 Subject: [PATCH 1/4] feat: update to mkdocs 9 --- docs/docs/getting-started.md | 2 +- docs/docs/setup/docker.md | 2 +- docs/mkdocs.yml | 1 + docs/requirements.txt | 43 +++++++++++++++++++++--------------- 4 files changed, 28 insertions(+), 20 deletions(-) diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index d1d8e0b..bb3bf4d 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -29,4 +29,4 @@ If you'd prefer to use OpenBooks from your terminal, check out [CLI Mode](./conf - Linux users may have to run `chmod +x [binary name]` to make it executable -> For more information see the [executable guide](./setup/executable.md). +> For more information see the [binary guide](./setup/binary.md). diff --git a/docs/docs/setup/docker.md b/docs/docs/setup/docker.md index 7dbacba..cf02b1d 100644 --- a/docs/docs/setup/docker.md +++ b/docs/docs/setup/docker.md @@ -1,7 +1,7 @@ [![Docker Pulls](https://img.shields.io/docker/pulls/evanbuss/openbooks.svg)](https://hub.docker.com/r/ evanbuss/openbooks/) -The OpenBooks docker image allows you to run [Server Mode](../modes/server.md). A multi-platform Docker container is published to Docker Hub for each release. +The OpenBooks docker image allows you to run server mode. A multi-platform Docker container is published to Docker Hub for each release. ## Docker Compose diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ec33479..ca5ed97 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -2,6 +2,7 @@ site_name: OpenBooks site_url: https://evan-buss.github.io/openbooks repo_name: OpenBooks repo_url: https://github.com/evan-buss/openbooks +edit_uri: tree/master/docs/docs markdown_extensions: - attr_list diff --git a/docs/requirements.txt b/docs/requirements.txt index 4e18b08..6903194 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,32 +1,39 @@ +Babel==2.15.0 cairocffi==1.4.0 CairoSVG==2.5.2 -certifi==2022.9.24 +certifi==2024.2.2 cffi==1.15.1 -charset-normalizer==2.1.1 -click==8.1.3 +charset-normalizer==3.3.2 +click==8.1.7 +colorama==0.4.6 cssselect2==0.7.0 defusedxml==0.7.1 ghp-import==2.1.0 -idna==3.4 -Jinja2==3.1.2 -Markdown==3.3.7 -MarkupSafe==2.1.1 +idna==3.7 +Jinja2==3.1.3 +Markdown==3.6 +MarkupSafe==2.1.5 mergedeep==1.3.4 -mkdocs==1.4.1 -mkdocs-material==8.5.7 -mkdocs-material-extensions==1.1 -packaging==21.3 +mkdocs==1.6.0 +mkdocs-get-deps==0.2.0 +mkdocs-material==9.5.21 +mkdocs-material-extensions==1.3.1 +packaging==24.0 +paginate==0.5.6 +pathspec==0.12.1 Pillow==9.3.0 +platformdirs==4.2.1 pycparser==2.21 -Pygments==2.13.0 -pymdown-extensions==9.7 +Pygments==2.18.0 +pymdown-extensions==10.8.1 pyparsing==3.0.9 -python-dateutil==2.8.2 -PyYAML==6.0 +python-dateutil==2.9.0.post0 +PyYAML==6.0.1 pyyaml_env_tag==0.1 -requests==2.28.1 +regex==2024.4.28 +requests==2.31.0 six==1.16.0 tinycss2==1.2.1 -urllib3==1.26.12 -watchdog==2.1.9 +urllib3==2.2.1 +watchdog==4.0.0 webencodings==0.5.1 From d9dea3d56387a05e042be79c4c9d83bb3173142a Mon Sep 17 00:00:00 2001 From: Evan Buss Date: Sun, 5 May 2024 21:11:11 +0000 Subject: [PATCH 2/4] chore: update changelog --- docs/docs/changelog.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/docs/changelog.md b/docs/docs/changelog.md index a8863c2..7993549 100644 --- a/docs/docs/changelog.md +++ b/docs/docs/changelog.md @@ -1,10 +1,22 @@ -# [v4.5.0] - 2023-01-08 +## [Development] -## Added -- Use `--useragent/-u` flag to optionally specify the [UserAgent](https://en.wikipedia.org/wiki/Client-to-client_protocol#VERSION) reported to the IRC server. Default remains `OpenBooks v4.5.0`. +### Added -## Breaking -- `--name/-n` flag **must** be specified when starting the application. OpenBooks will no longer generate a random `noun_adjective` username. -- Only a single connection to the IRC server will be made. Opening a second browser tab will show an error message. +- The IRC connection is kept open between page reloads / websocket disconnects. + - After the websocket is disconnected, the IRC connection will remain open until the websocket is reconnected or 3 minutes have passed. + This will prevent inadvertent bans from the IRC channel due to frequent connects/disconnects. +- Grid Improvements + - Column sorting + - Fuzzy searching across title / author columns + - Toggle column visibility + +## [v4.5.0] - 2023-01-08 + +### Added +- Use `--useragent/-u` flag to optionally specify the [UserAgent](https://en.wikipedia.org/wiki/Client-to-client_protocol#VERSION) reported to the IRC server. Default remains `OpenBooks v4.5.0`. +### Breaking + +- `--name/-n` flag **must** be specified when starting the application. OpenBooks will no longer generate a random `noun_adjective` username. +- Only a single connection to the IRC server will be made. Opening a second browser tab will show an error message. From 9440fdca5e4516e0d71457a26d60c57ef9d4d9e8 Mon Sep 17 00:00:00 2001 From: Evan Buss Date: Mon, 6 May 2024 00:22:31 +0000 Subject: [PATCH 3/4] fix: devcontainer script permissions - had to `chmod +x .devcontainer/setup.sh` - also added `lazygit` to the pre-installed tools --- .devcontainer/devcontainer.json | 2 +- .devcontainer/setup.sh | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 97e191b..ed1a854 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -6,7 +6,7 @@ // "forwardPorts": [], // Use 'postCreateCommand' to run commands after the container is created. - "postCreateCommand": "bash .devcontainer/setup.sh", + "postCreateCommand": "./.devcontainer/setup.sh", // Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. "remoteUser": "root", diff --git a/.devcontainer/setup.sh b/.devcontainer/setup.sh index 3612461..8c877ca 100644 --- a/.devcontainer/setup.sh +++ b/.devcontainer/setup.sh @@ -1,6 +1,7 @@ #!/bin/bash go install github.com/go-task/task/v3/cmd/task@latest +go install github.com/jesseduffield/lazygit@latest sudo apt update sudo apt install -y python3.10-venv From 60b4ec6c1d2be56cb41a0e0fb35b1e40c14f9953 Mon Sep 17 00:00:00 2001 From: Evan Buss Date: Mon, 6 May 2024 00:27:38 +0000 Subject: [PATCH 4/4] fix: only build docs in master branch - ideally, we'd have a version picker so we could preview the docs for the upcoming changes in development but it doesn't seem to be possible with the current gh-pages setup --- .github/workflows/docs.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index eb3867a..d49f4d5 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -7,6 +7,8 @@ on: push: paths: - "docs/**" + branches: + - "master" defaults: run: