Many minor updates and screenshots added

This commit is contained in:
kn0wmad
2021-12-17 17:47:25 -07:00
committed by Lucy Cifferello
parent 4c1d6a0e70
commit 01b8dad941
44 changed files with 294 additions and 141 deletions

View File

@@ -12,13 +12,18 @@ Do I need to be a professional developer or have coding experience to contribute
---------------------------------------------------------------------------------
Absolutely not! Contributions can be as simple as finding a typo in our docs, making a suggestion on GitHub, creating educational or promotional content, and the list goes on! Everyone that wants to contribute can do so in some unique way. Please don't hesitate to ***CONTACT LINK*** us for ideas if you're not sure where to begin.
The guide says that a Makefile is optional, why is this?
--------------------------------------------------------
The ``Makefile`` simplifies the development process by putting all your build steps into one place so that you can simply use the ``make`` to build with. A ``Makefile`` is not required however, and you may instead choose to use something like ``nix``, ``bash``, ``perl``, ``python``, or ``ruby`` for your build orchestration.
Expound the following into FAQs move to other dev-faq section if necessary:
---------------------------------------------------------------------------
- Release notes need to be in quotations? As it is a string? (they arent by default) this is a yaml thing and SOMETIMES they are required and SOMETIMES NOT
- Ports in manifest can leave as default (80), as it is a docker container?? - Sure
- Type definitions is this just for dependencies? Can a blurb be added here for extra clarity?
- Alerts in LND example are not wrapped in quotes, same with CUPS release notes yaml thing
- Ports in manifest can leave as default (80), as it is a docker container?? - Sure
- Type definitions is this just for dependencies? Can a blurb be added here for extra clarity?
- Config spec Admin pass?
- Makefile
- Not required, but simplifies dev process

View File

@@ -1,5 +1,9 @@
.. _faq-service-packaging:
.. contents::
:depth: 3
:local:
=====================
Service Packaging FAQ
=====================

View File

@@ -7,7 +7,7 @@ Developer FAQ
Frequently Asked Questions by and for developers. If you have a suggestion, please use the Github link at the top of the page.
.. toctree::
:hidden:
:maxdepth: 3
faq-contributing
faq-service-packaging

View File

@@ -1,8 +1,11 @@
.. _dev-docs:
==============
Developer Docs
==============
.. toctree::
:maxdepth: 2
:maxdepth: 3
:hidden:
dev-faq/index
@@ -14,6 +17,6 @@ Developer Docs
:id: "dev-docs"
:class: my-panel
* :doc:`Developer FAQ <dev-faq/index>` - Frequently asked questions for developers.
* :doc:`Service Packaging <service-packaging/index>` - Guides on how to package a service for EmbassyOS.
* :doc:`Package Example <packaging-example>` - An example based guide on how to package a service.
* :doc:`Developer FAQ <dev-faq/index>` - Frequently asked questions by developers in regard to EmbassyOS and packaging services.
* :doc:`Service Packaging <service-packaging/index>` - The full specification for packaging a service.
* :doc:`Package Example <packaging-example>` - A walkthrough of how to package a service using an example.