Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create initial documentation for public release #10

Closed
AmoebeLabs opened this issue Oct 14, 2020 · 1 comment
Closed

Create initial documentation for public release #10

AmoebeLabs opened this issue Oct 14, 2020 · 1 comment
Assignees
Labels
before release documentation Improvements or additions to documentation

Comments

@AmoebeLabs
Copy link
Owner

The Problem To Be Solved

Create initial documentation for public release, so first time users understand the basics

(Optional): Suggested Solution

Look at horseshoe documentation, and see what can be re-used...

@AmoebeLabs AmoebeLabs added documentation Improvements or additions to documentation before release labels Oct 14, 2020
@AmoebeLabs AmoebeLabs added this to the Public release milestone Oct 14, 2020
@AmoebeLabs AmoebeLabs self-assigned this Oct 14, 2020
@AmoebeLabs
Copy link
Owner Author

After research, the documentation is made using mkdocs-material.

Hosting is done using github pages (gh-pages) and the documentation is setup in a separate repository called swiss-army-knife

I'm using a docker container on my NUC and a share to edit the .md files. Portainers console feature is used to use git and mkdocks cli's, ie to put the sources into github, and publish the site to github pages!

Documentation is available on a subdomain: https://swiss-army-knife.docs.amoebelabs.com/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
before release documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant