immich icon indicating copy to clipboard operation
immich copied to clipboard

Published 20 hours ago • verified publisher icon immich-app

[Feature]: Documentation skeleton

Open alextran1502 opened this issue 3 years ago • 1 comments

Feature detail

This issue is for discussing and implementing the skeleton of the content for the documentation site.

This is what I have in mind currently, feel free to copy and add in your ideas, suggestions

Installation Guide

├── x86
│   ├── Bare-metal with docker-compose
│   ├── Portainer
├── Armv7
│   ├── Bare-metal with docker-compose
│   ├── Portainer

Reverse Proxy Guide

├── Nginx
├── Traefik
├── Caddy

Platform

Web

alextran1502 avatar Jun 21 '22 21:06 alextran1502

Not sure what goes in nginx, but you could probably include steps for nginxproxymanager.

In the docs you could also include troubleshooting steps, common pitfalls, errors, FAQs, and steps for upgrading.

jrasm91 avatar Aug 27 '22 20:08 jrasm91

New skeleton 10/2022

* Overview
	* Why is this app exist (and showcase)?
	* What is the meaning of the logo?
	* Technology stack
	* Support the project

* Installation (Include setup and update)
	* Requirement and Requisite
	* One-step installation
	* Docker-compose installation (Recommended)
	* Portainer using docker-compose
	* Unraid 
 
* Usage Explanation 
	* Common usage case
	* Android background backup

* Mobile App Beta Program
* FAQ

alextran1502 avatar Oct 24 '22 22:10 alextran1502

Implemented in docs

alextran1502 avatar Nov 22 '22 12:11 alextran1502