imAsparky / junction-box

A junction box is a place for making connections. Here, we document connections between technologies for our software development framework.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Junction Box


Junction Box


made-with-sphinx-doc

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Documentation Status Updates pre-commit Code style: black

A junction box is a place for making connections.


Here, we document connections between technologies for our software development framework.


Would you mind providing feedback or creating a discussion on our GitHub discussion board?


Junction Box documentation here.


Technologies

Here is the list of our chosen technologies where documentation is under active development and will be available when complete.

  1. Traefik Cloud-Native networking stack that just works.
  2. Docker Accelerate how you build, share, and run modern applications.
  3. Django makes it easier to build better web apps more quickly and with less code.

Documentation

  • Diátaxis is the documentation framework employed. Diátaxis adopts a systematic approach to structuring technical documentation. See the Diátaxis Quickstart here.

    See an excellent presentation at Pycon Melbourne 2017 by the creator of Diátaxis Daniele Procida.


  • Sphinx, created for the Python language, provides excellent facilities for documenting projects using various languages. This project uses reStructuredText.

  • Templates have been added to get documentation up and running fast. More templates are under development.

  • Semantic Versioning has been added. See the CHANGELOG for all the latest updates.

MORE TO COME!

About

A junction box is a place for making connections. Here, we document connections between technologies for our software development framework.

License:GNU General Public License v3.0


Languages

Language:Python 100.0%