Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 02:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update/submission brand meta (#359)

Browse Source 
* fix compilation error

* update theme with new brand assets, meta tags, and scroll fix

* update copy for submission process and fix typo

* update styles and brand assets
This commit is contained in:
Lucy C
2023-04-14 16:46:29 -06:00
committed by GitHub
parent 1ff7725456
commit 431853227f
7 changed files with 47 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
site/source/developer-docs/index.rst
View File

@@ -12,6 +12,15 @@ Developer Docs
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Listing a Service
:link: submission
:icon: scylla-icon scylla-icon--contact-us
:class: large-4
:anchor: Submit
The process for submitting a service to the Community Registry
.. topic-box::
:title: Service Packaging
:link: packaging
@@ -48,6 +57,7 @@ Developer Docs
:maxdepth: 1
:hidden:
submission
packaging
specification/index
advanced/index

6
site/source/developer-docs/packaging.rst
View File

@@ -299,6 +299,10 @@ The following files should be included in the service wrapper repository:
- `Example MAKEFILE <https://github.com/Start9Labs/hello-world-wrapper/blob/f44899be8523b784861aac92e43fe60f0bf219eb/Makefile#L1-L28>`_
- ``prepare.sh``
- A script that setups up the build environment for a Debian system so that Start9 can verify the build process upon submission.
- ``Dockerfile``
- A recipe for service creation
@@ -401,7 +405,7 @@ Testing
Submission and Distribution
===========================
The ``s9pk`` file can be uploaded for distribution to any website, repository, or marketplace. You can also submit your package for publication consideration on a Start9 Marketplace by emailing us at submissions@start9labs.com or by contacting us in one of our `community channels <https://start9.com/latest/about/contact>`_. Please include a link to the wrapper repository with a detailed README in the submission.
The ``s9pk`` file can be uploaded for distribution to any website, repository, or marketplace. You can also submit your package for publication to the Community Registry by following the :ref:`submission process <community-submission>`.
Advanced configuration
======================

31
site/source/developer-docs/submission.rst Normal file
View File

@@ -0,0 +1,31 @@
.. _community-submission:
============================
Community Submission Process
============================
**The following must be completed for initial publication as well as every new version of a service**
* The source code of the service wrapper and its upstream application must be public (source available)
* Send an email to submissions@start9.com containing a link to your polished service wrapper repository
* Start9 creates a snapshot of the repository
* Start9 reviews the codebase, inspecting for completeness and signs of foul play
* Start9 builds the service on our Debian build box (``prepare.sh`` and ``make<package-id>.s9pk``). Start9 will not spend time fighting build errors or debugging. If your script does not produce a production build on first try, we will reply with the relevant error so you can fix it.
* Start9 installs and tests the service on a StartOS machine. Start9 will NOT test or judge the service itself, only that it runs smoothly and safely on StartOS, including:
* Marketplace listing: the service must include all required metadata fields and valid links
* Install/Uninstall: the service must install and uninstall smoothly
* Instructions: if the service offers Instructions, they must display without error
* Properties: if the service offers Properties, they must display without error
* Config: if the service offers Config, it must function without error
* Dependencies: if the service depends on another service(s), it must properly utilize the StartOS dependency management system
* Actions: if the service offers Actions, they must run without error
* Health Checks: if the service offers Health Checks, they must display and run without error
* Interfaces: the service must offer at least one interface, otherwise there is no way to use it
* Logs: the logs page must display without error
* Compatibility: the service must run smoothly alongside the entire set of services on the Start9 Registry on a low resource device: think Raspberry PI (8GB) or an equivalent x86 machine
* Backup/Restore: the service must successfully backup and restore
Upon satisfying all the above criteria, Start9 will publish the s9pk to the Community Beta Registry and send you an email to confirm acceptance. Except in emergency situations, we highly recommend that you leave your service on Beta for a couple of days, such that it can be tested by your own testers plus anyone else who enjoys testing new releases. This will maximize the probability that any bugs will be caught before shipping to production.
When you are ready to publish to production, reply to the email, instructing Start9 to publish it. A simple "ship it" will do fine.