Error fixes, update About index, update contribute/teach (now contribute/content)

This commit is contained in:
kn0wmad
2022-08-18 11:00:33 -06:00
parent b0cba08a4d
commit dd8004ca7f
6 changed files with 105 additions and 86 deletions

79
poetry.lock generated
View File

@@ -59,8 +59,8 @@ python-versions = ">=3.6.0"
soupsieve = ">1.2"
[package.extras]
lxml = ["lxml"]
html5lib = ["html5lib"]
lxml = ["lxml"]
[[package]]
name = "certifi"
@@ -98,7 +98,7 @@ optional = false
python-versions = "*"
[package.extras]
test = ["hypothesis (==3.55.3)", "flake8 (==3.7.8)"]
test = ["flake8 (==3.7.8)", "hypothesis (==3.55.3)"]
[[package]]
name = "docutils"
@@ -274,8 +274,8 @@ py = ">=1.5.0"
wcwidth = "*"
[package.extras]
testing = ["xmlschema", "requests", "nose", "mock", "hypothesis (>=3.56)", "argcomplete"]
checkqa-mypy = ["mypy (==v0.761)"]
testing = ["argcomplete", "hypothesis (>=3.56)", "mock", "nose", "requests", "xmlschema"]
[[package]]
name = "pytz"
@@ -376,9 +376,9 @@ sphinxcontrib-qthelp = "*"
sphinxcontrib-serializinghtml = ">=1.1.5"
[package.extras]
test = ["typed-ast", "cython", "html5lib", "pytest-cov", "pytest"]
lint = ["types-requests", "types-typed-ast", "docutils-stubs", "mypy (>=0.931)", "isort", "flake8 (>=3.5.0)"]
docs = ["sphinxcontrib-websupport"]
lint = ["flake8 (>=3.5.0)", "isort", "mypy (>=0.931)", "docutils-stubs", "types-typed-ast", "types-requests"]
test = ["pytest", "pytest-cov", "html5lib", "cython", "typed-ast"]
[[package]]
name = "sphinx-autobuild"
@@ -409,8 +409,8 @@ python-versions = ">=3.7"
sphinx = ">=3"
[package.extras]
test = ["pytest", "pre-commit"]
doc = ["alabaster"]
test = ["pre-commit", "pytest"]
[[package]]
name = "sphinx-copybutton"
@@ -424,8 +424,8 @@ python-versions = ">=3.6"
sphinx = ">=1.8"
[package.extras]
rtd = ["sphinx-book-theme", "myst-nb", "ipython", "sphinx"]
code_style = ["pre-commit (==2.12.1)"]
rtd = ["sphinx", "ipython", "myst-nb", "sphinx-book-theme"]
[[package]]
name = "sphinx-multiversion-scylla"
@@ -496,8 +496,8 @@ docutils = ">=0.15"
sphinx = ">=4.0.0"
[package.extras]
dev = ["autoflake (==1.4)", "black (==22.1.0)", "check-manifest (==0.47)", "doc8 (==0.10.1)", "flake8-commas (==2.1.0)", "flake8-quotes (==3.3.1)", "flake8 (==4.0.1)", "isort (==5.10.1)", "mypy (==0.931)", "pip-check-reqs (==2.3.2)", "pydocstyle (==6.1.1)", "pyenchant (==3.2.2)", "pylint (==2.12.2)", "pyroma (==3.2)", "pytest-cov (==3.0.0)", "pytest (==7.0.1)", "types-docutils (==0.17.5)", "vulture (==2.3)"]
prompt = ["sphinx-prompt (>=0.1)"]
dev = ["vulture (==2.3)", "types-docutils (==0.17.5)", "pytest (==7.0.1)", "pytest-cov (==3.0.0)", "pyroma (==3.2)", "pylint (==2.12.2)", "pyenchant (==3.2.2)", "pydocstyle (==6.1.1)", "pip-check-reqs (==2.3.2)", "mypy (==0.931)", "isort (==5.10.1)", "flake8 (==4.0.1)", "flake8-quotes (==3.3.1)", "flake8-commas (==2.1.0)", "doc8 (==0.10.1)", "check-manifest (==0.47)", "black (==22.1.0)", "autoflake (==1.4)"]
[[package]]
name = "sphinx-tabs"
@@ -526,8 +526,8 @@ optional = false
python-versions = ">=3.5"
[package.extras]
lint = ["flake8", "mypy", "docutils-stubs"]
test = ["pytest"]
lint = ["docutils-stubs", "mypy", "flake8"]
[[package]]
name = "sphinxcontrib-devhelp"
@@ -538,8 +538,8 @@ optional = false
python-versions = ">=3.5"
[package.extras]
lint = ["flake8", "mypy", "docutils-stubs"]
test = ["pytest"]
lint = ["docutils-stubs", "mypy", "flake8"]
[[package]]
name = "sphinxcontrib-htmlhelp"
@@ -550,8 +550,8 @@ optional = false
python-versions = ">=3.6"
[package.extras]
test = ["html5lib", "pytest"]
lint = ["docutils-stubs", "mypy", "flake8"]
lint = ["flake8", "mypy", "docutils-stubs"]
test = ["pytest", "html5lib"]
[[package]]
name = "sphinxcontrib-jsmath"
@@ -562,7 +562,7 @@ optional = false
python-versions = ">=3.5"
[package.extras]
test = ["mypy", "flake8", "pytest"]
test = ["pytest", "flake8", "mypy"]
[[package]]
name = "sphinxcontrib-qthelp"
@@ -573,8 +573,8 @@ optional = false
python-versions = ">=3.5"
[package.extras]
lint = ["flake8", "mypy", "docutils-stubs"]
test = ["pytest"]
lint = ["docutils-stubs", "mypy", "flake8"]
[[package]]
name = "sphinxcontrib-serializinghtml"
@@ -585,8 +585,8 @@ optional = false
python-versions = ">=3.5"
[package.extras]
lint = ["flake8", "mypy", "docutils-stubs"]
test = ["pytest"]
lint = ["docutils-stubs", "mypy", "flake8"]
[[package]]
name = "sphinxcontrib-youtube"
@@ -601,7 +601,7 @@ requests = "*"
Sphinx = ">=0.6"
[package.extras]
doc = ["furo", "sphinx-copybutton"]
doc = ["sphinx-copybutton", "furo"]
[[package]]
name = "tornado"
@@ -628,9 +628,9 @@ optional = false
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4"
[package.extras]
brotli = ["brotlicffi (>=0.8.0)", "brotli (>=1.0.9)", "brotlipy (>=0.6.0)"]
secure = ["pyOpenSSL (>=0.14)", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "certifi", "ipaddress"]
socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"]
secure = ["ipaddress", "certifi", "idna (>=2.0.0)", "cryptography (>=1.3.4)", "pyOpenSSL (>=0.14)"]
brotli = ["brotlipy (>=0.6.0)", "brotli (>=1.0.9)", "brotlicffi (>=0.8.0)"]
[[package]]
name = "watchdog"
@@ -660,8 +660,8 @@ optional = false
python-versions = ">=3.7"
[package.extras]
testing = ["pytest-mypy (>=0.9.1)", "pytest-black (>=0.3.7)", "func-timeout", "jaraco.itertools", "pytest-enabler (>=1.3)", "pytest-cov", "pytest-flake8", "pytest-checkdocs (>=2.4)", "pytest (>=6)"]
docs = ["jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "jaraco.packaging (>=9)", "sphinx"]
docs = ["sphinx", "jaraco.packaging (>=9)", "rst.linker (>=1.9)", "jaraco.tidelift (>=1.4)"]
testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "pytest-cov", "pytest-enabler (>=1.3)", "jaraco.itertools", "func-timeout", "pytest-black (>=0.3.7)", "pytest-mypy (>=0.9.1)"]
[metadata]
lock-version = "1.1"
@@ -677,13 +677,8 @@ argh = [
{file = "argh-0.26.2-py2.py3-none-any.whl", hash = "sha256:a9b3aaa1904eeb78e32394cd46c6f37ac0fb4af6dc488daa58971bdc7d7fcaf3"},
{file = "argh-0.26.2.tar.gz", hash = "sha256:e9535b8c84dc9571a48999094fda7f33e63c3f1b74f3e5f3ac0105a58405bb65"},
]
atomicwrites = [
{file = "atomicwrites-1.4.1.tar.gz", hash = "sha256:81b2c9071a49367a7f770170e5eec8cb66567cfbbc8c73d20ce5ca4a8d71cf11"},
]
attrs = [
{file = "attrs-22.1.0-py2.py3-none-any.whl", hash = "sha256:86efa402f67bf2df34f51a335487cf46b1ec130d02b8d39fd248abfd30da551c"},
{file = "attrs-22.1.0.tar.gz", hash = "sha256:29adc2665447e5191d0e7c568fde78b21f9672d344281d0c6e1ab085429b22b6"},
]
atomicwrites = []
attrs = []
babel = [
{file = "Babel-2.10.3-py3-none-any.whl", hash = "sha256:ff56f4892c1c4bf0d814575ea23471c230d544203c7748e8c68f0089478d48eb"},
{file = "Babel-2.10.3.tar.gz", hash = "sha256:7614553711ee97490f732126dc077f8d0ae084ebc6a96e23db1482afabdb2c51"},
@@ -773,10 +768,7 @@ markupsafe = [
{file = "MarkupSafe-2.1.1-cp39-cp39-win_amd64.whl", hash = "sha256:46d00d6cfecdde84d40e572d63735ef81423ad31184100411e6e3388d405e247"},
{file = "MarkupSafe-2.1.1.tar.gz", hash = "sha256:7f91197cc9e48f989d12e4e6fbc46495c446636dfc81b9ccf50bb0ec74b91d4b"},
]
more-itertools = [
{file = "more-itertools-8.14.0.tar.gz", hash = "sha256:c09443cd3d5438b8dafccd867a6bc1cb0894389e90cb53d227456b0b0bccb750"},
{file = "more_itertools-8.14.0-py3-none-any.whl", hash = "sha256:1bc4f91ee5b1b31ac7ceacc17c09befe6a40a503907baf9c839c229b5095cfd2"},
]
more-itertools = []
packaging = [
{file = "packaging-21.3-py3-none-any.whl", hash = "sha256:ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"},
{file = "packaging-21.3.tar.gz", hash = "sha256:dd47c42927d89ab911e606518907cc2d3a1f38bbd026385970643f9c5b8ecfeb"},
@@ -795,10 +787,7 @@ py = [
{file = "py-1.11.0-py2.py3-none-any.whl", hash = "sha256:607c53218732647dff4acdfcd50cb62615cedf612e72d1724fb1a0cc6405b378"},
{file = "py-1.11.0.tar.gz", hash = "sha256:51c75c4126074b472f746a24399ad32f6053d1b34b68d2fa41e558e6f4a98719"},
]
pygments = [
{file = "Pygments-2.13.0-py3-none-any.whl", hash = "sha256:f643f331ab57ba3c9d89212ee4a2dabc6e94f117cf4eefde99a0574720d14c42"},
{file = "Pygments-2.13.0.tar.gz", hash = "sha256:56a8508ae95f98e2b9bdf93a6be5ae3f7d8af858b43e02c5a2ff083726be40c1"},
]
pygments = []
pyparsing = [
{file = "pyparsing-3.0.9-py3-none-any.whl", hash = "sha256:5026bae9a10eeaefb61dab2f09052b9f4307d44aee4eda64b309723d8d206bbc"},
{file = "pyparsing-3.0.9.tar.gz", hash = "sha256:2b020ecf7d21b687f219b71ecad3631f644a47f01403fa1d1036b0c6416d70fb"},
@@ -807,10 +796,7 @@ pytest = [
{file = "pytest-5.4.3-py3-none-any.whl", hash = "sha256:5c0db86b698e8f170ba4582a492248919255fcd4c79b1ee64ace34301fb589a1"},
{file = "pytest-5.4.3.tar.gz", hash = "sha256:7979331bfcba207414f5e1263b5a0f8f521d0f457318836a7355531ed1a4c7d8"},
]
pytz = [
{file = "pytz-2022.2.1-py2.py3-none-any.whl", hash = "sha256:220f481bdafa09c3955dfbdddb7b57780e9a94f5127e35456a48589b9e0c0197"},
{file = "pytz-2022.2.1.tar.gz", hash = "sha256:cea221417204f2d1a2aa03ddae3e867921971d0d76f14d87abb4414415bbdcf5"},
]
pytz = []
pyyaml = [
{file = "PyYAML-6.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d4db7c7aef085872ef65a8fd7d6d09a14ae91f691dec3e87ee5ee0539d516f53"},
{file = "PyYAML-6.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9df7ed3b3d2e0ecfe09e14741b857df43adb5a3ddadc919a2d94fbdf78fea53c"},
@@ -885,10 +871,7 @@ sphinx-copybutton = [
sphinx-multiversion-scylla = [
{file = "sphinx-multiversion-scylla-0.2.10.tar.gz", hash = "sha256:b54d664ecedcf45b98d6be1e939eac596719daa514e4a35f58d8e6330fb05d22"},
]
sphinx-notfound-page = [
{file = "sphinx-notfound-page-0.8.3.tar.gz", hash = "sha256:f728403280026b84c234540bebbed7f710b9ea582e7348a35a5becefe4024332"},
{file = "sphinx_notfound_page-0.8.3-py2.py3-none-any.whl", hash = "sha256:c4867b345afccef72de71fb410c412540dfbb5c2de0dc06bde70b331b8f30469"},
]
sphinx-notfound-page = []
sphinx-scylladb-theme = [
{file = "sphinx-scylladb-theme-1.2.1.tar.gz", hash = "sha256:55923651acb74988755fd818175999e953e018d372cb778dd5120b03f71fe5ab"},
{file = "sphinx_scylladb_theme-1.2.1-py3-none-any.whl", hash = "sha256:2666a6990c87c9601beb0c49f118e87d03b27c248ad263e553c3c9dbd9247ec9"},
@@ -949,10 +932,7 @@ typing-extensions = [
{file = "typing_extensions-4.3.0-py3-none-any.whl", hash = "sha256:25642c956049920a5aa49edcdd6ab1e06d7e5d467fc00e0506c44ac86fbfca02"},
{file = "typing_extensions-4.3.0.tar.gz", hash = "sha256:e6d2677a32f47fc7eb2795db1dd15c1f34eff616bcaf2cfb5e997f854fa1c4a6"},
]
urllib3 = [
{file = "urllib3-1.26.11-py2.py3-none-any.whl", hash = "sha256:c33ccba33c819596124764c23a97d25f32b28433ba0dedeb77d873a38722c9bc"},
{file = "urllib3-1.26.11.tar.gz", hash = "sha256:ea6e8fb210b19d950fab93b60c9009226c63a28808bc8386e05301e25883ac0a"},
]
urllib3 = []
watchdog = [
{file = "watchdog-2.1.9-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a735a990a1095f75ca4f36ea2ef2752c99e6ee997c46b0de507ba40a09bf7330"},
{file = "watchdog-2.1.9-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:6b17d302850c8d412784d9246cfe8d7e3af6bcd45f958abb2d08a6f8bedf695d"},
@@ -984,7 +964,4 @@ wcwidth = [
{file = "wcwidth-0.2.5-py2.py3-none-any.whl", hash = "sha256:beb4802a9cebb9144e99086eff703a642a13d6a0052920003a230f3294bbe784"},
{file = "wcwidth-0.2.5.tar.gz", hash = "sha256:c4d647b99872929fdb7bdcaa4fbe7f01413ed3d98077df798530e5b04f116c83"},
]
zipp = [
{file = "zipp-3.8.1-py3-none-any.whl", hash = "sha256:47c40d7fe183a6f21403a199b3e4192cca5774656965b0a4988ad2f8feb5f009"},
{file = "zipp-3.8.1.tar.gz", hash = "sha256:05b45f1ee8f807d0cc928485ca40a07cb491cf092ff587c0df9cb1fd154848d2"},
]
zipp = []

View File

@@ -68,6 +68,4 @@ About
start9
privacy
license
jobs
.. roadmap
.. team
jobs

View File

@@ -0,0 +1,55 @@
.. _content:
==============
Create Content
==============
.. tip:: If you aren't sure where to start, please reach out to the :ref:`Start9 Community<contact>`, we're happy to help!!
One of the most important things an individual can do to help the movement is to get the word out about sovereign computing and help others learn how to declare their own independence.
Feedback
--------
We thrive on user feedback!
Write reviews or blog posts on Medium, Substack, Reddit, Mastodon, Twitter, or others
It may not seem like it, but a single review can teach us a lot. Further, as these reviews add up, we can better understand pain points and popular requests.
Whether you just like our ethos, had a good experience with a support call, or want to do a full unboxing/test/review/how-to, ALL feedback is valuable and helps spread the message at the same time!
Notes:
- Tag us!! We read them all, but we will not see them if they are not brought to our attention.
- Give details. If you have no complaints, that's great, but please list something specific that you DO like.
Audio / Video Content
---------------------
Online A/V content is incredibly powerful. Whether you are a professional creator or this is your first time, it is certain that you will bring unique value to others.
- Memes
- Images or gifs
- Share in our :ref:`channels<contact>`
- Video
- Device unboxing
- How-to guides
- Comparisons with other similar projects
- Short or long-form reviews
- Philosophical or technical concepts
- Audio
- Podcasts, radio shows, or quick messages
- Philosophical or technical concepts
- Interviews / conversations (Please :ref:`Reach out<contact>` to us!)
- Create audio from existing text content
Documentation
-------------
Contribute to our `Documentation <https://github.com/Start9Labs/documentation>`_. A large percentage of fixes and updates come from our community.
- Fix a typo
- Add or improve an FAQ or guide
- Request a how-to or explanation
- Make a general suggestion
.. tip:: You can find a link to submit a fix or report an issue near the top-right of each page (labeled ``Contribute``)

View File

@@ -13,49 +13,49 @@ Contribute
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Teach
:link: teach
:title: Create Content
:link: content
:icon: scylla-icon scylla-icon--tech-talks
:class: large-4
:anchor: Join the movement
:anchor: Make
Share your knowledge with the community.
Share your knowledge with the community and amplify the signal.
.. topic-box::
:title: Provide Support
:link: provide-support
:icon: scylla-icon scylla-icon--support
:class: large-4
:anchor: Help
:anchor: Assist
Learn how you can help provide community support.
Help guide community members that are earlier in their path than you.
.. topic-box::
:title: Decentralize
:title: Decentralize the Ecosystem
:link: decentralize
:icon: scylla-icon scylla-icon--cloud
:class: large-4
:anchor: View
:anchor: Build
See how you can aid in decentralizing our architecture.
Help create the new Internet by bootstrapping necessary infrastructure.
.. topic-box::
:title: Promote
:title: Promote Start9
:link: promote
:icon: scylla-icon scylla-icon--summit
:class: large-4
:anchor: Join
:anchor: Shill
Become an affiliate and help promote Start9.
Become an affiliate and help propagate the message to your audience.
.. topic-box::
:title: Jobs
:title: Join the Team
:link: jobs
:icon: scylla-icon scylla-icon--about-team
:class: large-4
:anchor: Join us
:anchor: Work
See our available positions.
Check for available core Start9 team positions or contracts.
.. raw:: html
@@ -66,7 +66,7 @@ Contribute
:maxdepth: 2
:hidden:
teach
content
provide-support
decentralize
promote

View File

@@ -1,11 +0,0 @@
.. _teach:
=====
Teach
=====
One of the most important things an individual can do to help the movement is to get the word out about sovereign computing and help others learn how to declare their own independence.
- Write reviews or blog posts on Medium, Substack, Reddit, Mastodon, Twitter, etc.
- Contribute to our `Documentation <https://github.com/Start9Labs/documentation>`_, whether you find a typo, have an FAQ to add, or tutorial to improve. You can also find a link to submit a fix or report an issue near the top of this page (labeled ``Contribute``).
- Create videos - how-tos, comparisons, unboxings, and reviews are all helpful.

View File

@@ -1,4 +1,4 @@
.. _js_procedure:
.. _js-procedure:
============
JS Procedure
@@ -58,10 +58,10 @@ How to Setup
export const dependencies: T.ExpectedExports.dependencies = todo;
/** Fill this out when manifest @ health-checks.<packageName>.type = script */
export const health: T.ExpectedExports.health = todo;
/** Fill this out when manifest @ migrations.<from/to>.<emver>.type = script
/** Fill this out when manifest @ migrations.<from/to>.<emver>.type = script */
export const migration: T.ExpectedExports.migration = todo;
Note: Not all the exports are needed unless one uses the following configuration settings in ``manifest.yaml``
.. note:: Not all the exports are needed unless one uses the following configuration settings in ``manifest.yaml``
3. Modify service manifest to use the script type like so:
@@ -73,8 +73,8 @@ How to Setup
set:
type: script
4. Fill in the todos in the above template to match the expected Effect parameter defined by the `exported type <https://deno.land/x/embassyd_sdk@v0.3.1.0.3/types.ts#L32> `__. This type describes how to call functions that interact with EmbassyOS.
5. In the build process for packaging the final s9pk, include the following step. **The location of the js is important, and can't be changed**. It must exist at `scripts/embassy.js`in the root of the project's wrapper repository.
4. Fill in the todos in the above template to match the expected Effect parameter defined by the `exported type <https://deno.land/x/embassyd_sdk@v0.3.1.0.3/types.ts#L32>`_. This type describes how to call functions that interact with EmbassyOS.
5. In the build process for packaging the final s9pk, include the following step. **The location of the js is important, and can't be changed**. It must exist at `scripts/embassy.js` in the root of the project's wrapper repository.
.. code:: bash