mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
Fix/updates (#82)
* style updats * remove step from title * add contents for small screen submenu display * adjust footer
This commit is contained in:
@@ -1,8 +1,12 @@
|
||||
.. _packaging-framework:
|
||||
|
||||
==================
|
||||
Step 1 - Framework
|
||||
==================
|
||||
=============
|
||||
1 - Framework
|
||||
=============
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
What we'll build
|
||||
----------------
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-create-service:
|
||||
|
||||
=======================
|
||||
Step 2 - Create Service
|
||||
=======================
|
||||
==================
|
||||
2 - Create Service
|
||||
==================
|
||||
|
||||
For this example, we are going to create a simple Rust project that serves a static web page.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-compile-raspi:
|
||||
|
||||
=======================
|
||||
Step 3 - Hardware Build
|
||||
=======================
|
||||
==================
|
||||
3 - Hardware Build
|
||||
==================
|
||||
|
||||
EmbassyOS is run on the arm-v8 architecture, specifically the aarch64 state, for the RaspberryPi.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-docker-build:
|
||||
|
||||
=====================
|
||||
Step 4 - Docker Build
|
||||
=====================
|
||||
================
|
||||
4 - Docker Build
|
||||
================
|
||||
|
||||
Now that we have our code properly built/compiled, we can create a Dockerfile. This file defines how to build the Docker image for the service by declaring the environment, building stages, and copying any binaries or assets needed to run the service to the Docker image filesystem.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-create-manifest:
|
||||
|
||||
========================
|
||||
Step 5 - Create Manifest
|
||||
========================
|
||||
===================
|
||||
5 - Create Manifest
|
||||
===================
|
||||
|
||||
The Manifest file specifies the details EmbassyOS needs to operate a service. It is the connection point between your service and EmbassyOS.
|
||||
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
.. _packaging-create-assets:
|
||||
|
||||
======================
|
||||
Step 6 - Create Assets
|
||||
======================
|
||||
=================
|
||||
6 - Create Assets
|
||||
=================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Each ``s9pk`` package contains a set of assets. They include:
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-create-s9pk:
|
||||
|
||||
=======================
|
||||
Step 7 - Format Package
|
||||
=======================
|
||||
==================
|
||||
7 - Format Package
|
||||
==================
|
||||
|
||||
We now have all of the necessary components to package the service into the format needed for the OS. This format is a custom filetype with an extension of ``.s9pk``, short for Start9 Package.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-makefile:
|
||||
|
||||
========================
|
||||
Step 8 - Create Makefile
|
||||
========================
|
||||
===================
|
||||
8 - Create Makefile
|
||||
===================
|
||||
|
||||
For convenience and repeatability, let's combine all of these commands into a Makefile. Then, we can use `make <https://www.gnu.org/software/make/>`_ to rebuild our project quickly.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-create-wrapper:
|
||||
|
||||
=======================
|
||||
Step 9 - Create Wrapper
|
||||
=======================
|
||||
==================
|
||||
9 - Create Wrapper
|
||||
==================
|
||||
|
||||
In order for the Start9 team to review your package for submission to the Start9 Marketplace, we ask that you create a wrapper repository for the project and its components. This repo should contain everything you need to build the service.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
.. _packaging-install:
|
||||
|
||||
=================
|
||||
Step 10 - Install
|
||||
=================
|
||||
============
|
||||
10 - Install
|
||||
============
|
||||
|
||||
Now that we have a process for iterating on producing a valid package for EmbassyOS, let's load it onto an Embassy!
|
||||
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Resources
|
||||
=========
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
Get help
|
||||
--------
|
||||
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
.. _packaging-quick-start:
|
||||
|
||||
=====================
|
||||
Packaging Quick Start
|
||||
=====================
|
||||
=========
|
||||
Checklist
|
||||
=========
|
||||
|
||||
.. contents::
|
||||
: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 <build-package-example>` guide.
|
||||
|
||||
@@ -4,6 +4,10 @@
|
||||
Environment Setup
|
||||
=================
|
||||
|
||||
.. contents::
|
||||
:depth: 2
|
||||
:local:
|
||||
|
||||
To get started packaging a service for EmbassyOS, some basic knowledge of software development is required. Don't worry if you are inexperienced, we will provide enough context to get you started, and you can always reach out with questions.
|
||||
|
||||
If you are already an experienced developer, :ref:`jump ahead <environment-quick-start>`.
|
||||
|
||||
@@ -60,4 +60,4 @@ Getting Started Overview
|
||||
|
||||
environment-setup
|
||||
sdk
|
||||
quick-start
|
||||
checklist
|
||||
@@ -15,7 +15,7 @@ Due to the fact that config variables are only available when the service is run
|
||||
Service Properties
|
||||
|
||||
|
||||
.. code-block:: javascript
|
||||
.. code-block:: TypeScript
|
||||
:caption: Properties Type
|
||||
|
||||
interface Properties {
|
||||
|
||||
Reference in New Issue
Block a user