From 018f48e1a0aec2081394e7e7012f59400c09f877 Mon Sep 17 00:00:00 2001 From: kn0wmad Date: Thu, 1 Dec 2022 11:27:07 -0700 Subject: [PATCH] Various cleanup, error fixes --- poetry.lock | 12 ++++++------ site/03-todo.md | 8 -------- site/source/developer-docs/packaging.rst | 5 +++-- .../developer-docs/specification/checklist.rst | 2 +- 4 files changed, 10 insertions(+), 17 deletions(-) delete mode 100644 site/03-todo.md diff --git a/poetry.lock b/poetry.lock index 7af3abb..8a65e10 100644 --- a/poetry.lock +++ b/poetry.lock @@ -126,7 +126,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "importlib-metadata" -version = "5.0.0" +version = "5.1.0" description = "Read metadata from Python packages" category = "main" optional = false @@ -139,7 +139,7 @@ zipp = ">=0.5" [package.extras] docs = ["sphinx (>=3.5)", "jaraco.packaging (>=9)", "rst.linker (>=1.9)", "furo", "jaraco.tidelift (>=1.4)"] perf = ["ipython"] -testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "flake8 (<5)", "pytest-cov", "pytest-enabler (>=1.3)", "packaging", "pyfakefs", "flufl.flake8", "pytest-perf (>=0.9.2)", "pytest-black (>=0.3.7)", "pytest-mypy (>=0.9.1)", "importlib-resources (>=1.3)"] +testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "flake8 (<5)", "pytest-cov", "pytest-enabler (>=1.3)", "packaging", "pyfakefs", "flufl.flake8", "pytest-perf (>=0.9.2)", "pytest-black (>=0.3.7)", "pytest-mypy (>=0.9.1)", "pytest-flake8", "importlib-resources (>=1.3)"] [[package]] name = "jinja2" @@ -621,11 +621,11 @@ python-versions = ">=3.7" [[package]] name = "urllib3" -version = "1.26.12" +version = "1.26.13" description = "HTTP library with thread-safe connection pooling, file post, and more." category = "main" optional = false -python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4" +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*" [package.extras] brotli = ["brotlicffi (>=0.8.0)", "brotli (>=1.0.9)", "brotlipy (>=0.6.0)"] @@ -653,7 +653,7 @@ python-versions = "*" [[package]] name = "zipp" -version = "3.10.0" +version = "3.11.0" description = "Backport of pathlib-compatible object wrapper for zip files" category = "main" optional = false @@ -661,7 +661,7 @@ python-versions = ">=3.7" [package.extras] docs = ["sphinx (>=3.5)", "jaraco.packaging (>=9)", "rst.linker (>=1.9)", "furo", "jaraco.tidelift (>=1.4)"] -testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "flake8 (<5)", "pytest-cov", "pytest-enabler (>=1.3)", "jaraco.itertools", "func-timeout", "jaraco.functools", "more-itertools", "pytest-black (>=0.3.7)", "pytest-mypy (>=0.9.1)"] +testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "flake8 (<5)", "pytest-cov", "pytest-enabler (>=1.3)", "jaraco.itertools", "func-timeout", "jaraco.functools", "more-itertools", "pytest-black (>=0.3.7)", "pytest-mypy (>=0.9.1)", "pytest-flake8"] [metadata] lock-version = "1.1" diff --git a/site/03-todo.md b/site/03-todo.md deleted file mode 100644 index 7b01805..0000000 --- a/site/03-todo.md +++ /dev/null @@ -1,8 +0,0 @@ -- Initial Setup Video -- Vaultwarden guide (screens) -- Lightning Guides (Zeus) -- Refactor and update Roadmap ---- -- Breakout Bitcoin / Lightning integrations into their own individual pages(?) -- Migrate from other server projects / nodes (currently punted) -- Alt Market Build Guide (punted) diff --git a/site/source/developer-docs/packaging.rst b/site/source/developer-docs/packaging.rst index 081c5c4..6a3f22d 100644 --- a/site/source/developer-docs/packaging.rst +++ b/site/source/developer-docs/packaging.rst @@ -8,7 +8,7 @@ Service Packaging :depth: 2 :local: -Welcome! Thank you for your interest in contributing to the growing ecosystem of open software. We call the software applications that run on `embassyOS `_ "services." This distinction is made to differentiate from "applications" (apps), which are generally run on a client, and used to access server-side software (services). To run services on embassyOS, a package of file components needs to be composed. This guide will dive into the basic structure of how to compose this package. +Welcome! Thank you for your interest in contributing to the growing ecosystem of open software. We call the software applications that run on :ref:`embassyOS` "services." This distinction is made to differentiate from "applications" (apps), which are generally run on a client, and used to access server-side software (services). To run services on embassyOS, a package of file components needs to be composed. This guide will dive into the basic structure of how to compose this package. Check out the :ref:`glossary ` to get acquainted with unfamiliar terms. The bottom of this guide also includes :ref:`support ` links, including a master checklist. @@ -240,7 +240,7 @@ The following files should be included in the service wrapper repository: - Build instructions to create the s9pk - - `Example `_ + - `Example MAKEFILE `_ - ``Dockerfile`` @@ -249,6 +249,7 @@ The following files should be included in the service wrapper repository: - Add here any prerequisite environment variables, files, or permissions - Examples: + - `Using an existing docker image `_ - `Implementing a database `_ - `Using a submodule `_ diff --git a/site/source/developer-docs/specification/checklist.rst b/site/source/developer-docs/specification/checklist.rst index bb9506c..8d70141 100644 --- a/site/source/developer-docs/specification/checklist.rst +++ b/site/source/developer-docs/specification/checklist.rst @@ -8,7 +8,7 @@ Checklist :depth: 2 :local: -This guide outlines a checklist of steps to complete in order to package a service for embassyOS. For a more in depth example, visit the :ref:`build your first package ` guide. +This guide outlines a checklist of steps to complete in order to package a service for embassyOS. For a more in depth example, visit the :ref:`build your first package ` guide. Packaging ---------