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

Update actions branch to current dev #65

Merged
merged 19 commits into from
Oct 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 199 additions & 0 deletions docs/dietpi_docs_todo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
# Documentation Ideas & Tasks

## 1. Development general

### 1.1 Branching
1. Q: Shall we use (personal) branches to push changes directly into the master branch, or shall we use forking mechanisms?
2. If using branches, which naming conventions shall we use for branch names (e.g. "dev-<short name>-<ChangeArea>". Example: "dev-StS-AddBoardImages" or "dev-MiI-DescribeWebserverStacks")

Have branches on MichaIng/DietPi-Docs:
- master branch: stable
- dev branch: work on this branch and will be merged into master branch at planned release dates

Everyone works on his own fork for development. There "private" branches with "private" naming can be chosen.

Committing changes from the private fork branch to the dev branch on Micha's repo shall be done via a pull request.

Merging should be done via 4-eyes method when merging to the master branch.

- [x] Rules are now enabled.

## 2. Files general

### 2.1 Filenames .md

- Some of the filenames use '-', others use '_'.
e.g. dietpi-software-bittorrent.md vs. user-guide_install.md.
I would prefer the latter one: `<docu type>_<chapter contents>.md`.

**Style Guide**:
```
<docu type>_<chapter contents>.md, all lower case
Example: user-guide_install.md.
```

ToDo: Change file names initially.
Remark: Google search should be considered.

- [x] Petru to enable the new naming rules

### 2.2 File structure
Q: Shall we structure every chapter to subdirs (with own assets sub-subdirs)?
This could lead to a more general structure if the docu is extending.

Could this lead to problems when chapters or images are used several times?

Open point, has to be cleared.

- [x] Petru to enable new file structure

## 3. Installation chapter
### 3.1 Docu structure

Today:

- Installation (*covers SBC installation* and *First boot on DietPi*)
- Advanced installation
- Install DietPi on native PC
- Install DietPi as an Oracle VirtualBox machine

Proposal:

- **Installation** (*covers overview over several options: SBC, PC, virtual machine*)
- **Installation on SBC** ([contents](https://dietpi.com/docs/user-guide_install/))
- **Installation on native PC** ([contents](https://dietpi.com/docs/user-guide_install_uefi/))
- **Installation on VirtualBox machine** ([contents](https://dietpi.com/docs/user-guide_install_VirtualBox/))
- (later: - **Installation on VmWare virtual machine**)
- **First boot on DietPi** (move this from the [*Installation on SBC*](https://dietpi.com/docs/user-guide_install/#3-first-boot-on-dietpi) section to here)


Idea:
- Use tabs in the content area (like there: https://dietpi.com/docs/dietpi-software-desktop/#lxde-ultra-lightweight-desktop) to distinguish between SBC, native PC, VirtualBox,etc. Below the tab area the *First boot on DietPi* section is located.

- [ ] **ToDo Stephan:** Implement the changed *Installation* structure.

### 3.2 Description of *dietpi-software* usage

1. Move [4. Install software with the DietPi-Software tool](https://dietpi.com/docs/user-guide_install/#4-install-software-with-the-dietpi-software-tool) to [DietPi Optimised software Index](https://dietpi.com/docs/user-optimised-software/) ?
*dietpi-software* should not be a tool which is run only once during the installation.

Shall be moved to *Getting started*.

- [ ] **ToDo Stephan:** Move contents.

*Getting started* shall contain often used procedures. Seldom used procedures shall be in *Advanced configuration & DietPi tools*.

- go ahead here

## 4 Supported Single Board Computers (SBCs)

See there: https://dietpi.com/docs/hardware-supported_sbc/.

### 4.1 Structure of chapters
Harmonize/rearrange order in all sub-chapters:

- Heading
- Hardware description
- Picture of hardware
- Link table to images


- [ ] **ToDo Stephan:** Harmonize sections.


### 4.2 Supported Single Board Computers (SBCs)
1. Move *NanoPi Series (FriendlyARM)* below *ASUS Tinker Board*

- [ ] **ToDo Stephan:** Change order.


### 4.3 Description of DietPi PREP?
1. Q: Shall we describe this issue in a comprehensive form?
Possibly this will lead to too much questions?

Actually it is only referenced at the end of the [*Supported SBC* section](https://dietpi.com/docs/hardware-supported_sbc/#make-your-own-distribution).

- [ ] **ToDo Stephan:** Make a proposal with some more screenshots.
Basically use *master* branch, use *dev* for hardening/testing Micha's PREP-script.


### 4.4 Name of .md file
1. Q: Rename *hardware-supported_sbc.md* to *user-guide_supported_sbc.md*

- [x] **Done** with renaming/restructuring from Petru.


### 4.5 Images
Add images for
- Firefly
- Sparky SBC (Allo)

The images are available on Dietpi.com\Download.

- [ ] **ToDo Stephan:** Add images.


## 5. Desktops
Desktop basics (https://dietpi.com/docs/dietpi-software-desktop/):
1. Add a section how to setup the ***Autostart options*** via ***dietpi-config*** to start with LightDM
- Have it similar to the collapsable description *How do I run DietPi-Software and install Optimised software ?*

- [x] **No extra description, because this is already described in the tab page *Enable autostart*.**


LXQt (https://dietpi.com/docs/dietpi-software-desktop/#lxqt-optimized-lightweight-desktop):
1. Add screenshot of desktop

- [ ] **ToDo Stephan:** Add image.



## 6. DietPi Tools
See there: https://dietpi.com/docs/user-guide_tools/
1. Add a screenshot for *Software Additional*

- [ ] **Todo Stephan:** Move dietpi-software main menu screenshot above the tabs selection
- [ ] **Todo Stephan:** Add a screenshot for *Software Additional* within the corresponding tab section



## 7. Description of Webserver stacks
See there: https://dietpi.com/docs/dietpi-software-webserver-stack/
1. Add a section how to select the webservers stacks via ***dietpi-software***. Two options: Select via *Software Optimized* or via *Webserver Preference* (Preference is used in the case of the first webserver background installation).
2. Section [Webservers](https://dietpi.com/docs/dietpi-software-webserver-stack/#webservers): Exchange the three bullets with the description "behind the links" ([*Webserver Preference System*](https://dietpi.com/phpbb/viewtopic.php?p=1549#p1549)):
- Remove the links, but keep the three bullets
- Port the description *Webserver Preference System* to this section
3. How to port the stack description to the Webserver stacks section? Idea:
- Divide the description into sections about webservers, about data bases and about PHP.


## 8. Links *Return to the Optimised Software list*
See there: https://dietpi.com/docs/dietpi-software-webserver-stack/
At the bottom there is a link to jump back.
Q: Is this linking done in all necessary pages? If no, where should it be inserted?

- [x] **Already done in this way.**



## 9. Gitea software
### 9.1 Prerequisites
Describe/check user rights of dietpi user and letsencrypt.

### 9.2 Add section "hardening Gitea for external access (behind a router)"
- Describe fail2ban usage unter "external access".
See: https://docs.gitea.io/en-us/fail2ban-setup/
- Describe combination Gitea and letsencrypt. Then use https for access.


Alternative:
- Add a general *hardening with https:* description in the webserver section (where in detail?).
See also there: https://github.com/MichaIng/DietPi/wiki/Security-recommendation.
- Reference this hardening section from the software titles and add there specialities of the software title hardening


## 10. Backup/Restore
Describe Backup/Restore:
- via dietpi-backup
- via different/other backup solutions
E.g. see https://www.linuxlinks.com/backup/
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,25 @@

![DietPi Software](assets/images/dietpi-software.jpg)

To see all the DietPi configurations options, review [DietPi Tools](../user-guide_tools) section.
To see all the DietPi configurations options, review [DietPi Tools](../dietpi_tools) section.

!!! warning "Documentation in progress..."
The **Optimised Software** links marked in **bold** have a more detailed description. The other links redirect to the old documentation (available on [DietPi.com Forum](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5))

## [Desktops](../dietpi-software-desktop)
- [**LXDE - Highly optimized ultra lightweight desktop**](../dietpi-software-desktop/#lxde-ultra-lightweight-desktop)
- [**LXQt - Slick and optimized lightweight desktop**](../dietpi-software-desktop/#lxqt-optimized-lightweight-desktop)
- [**MATE - Popular Gnome 2 desktop**](../dietpi-software-desktop/#mate-popular-gnome2-desktop)
- [**Xfce - Lightweight desktop**](../dietpi-software-desktop/#xfce-lightweight-desktop)
- [**GnuStep - Alternative/unique desktop**](../dietpi-software-desktop/#gnustep-alternativeunique-desktop)
## [Desktops](../software/desktop)
- [**LXDE - Highly optimized ultra lightweight desktop**](../software/desktop/#lxde-ultra-lightweight-desktop)
- [**LXQt - Slick and optimized lightweight desktop**](../software/desktop/#lxqt-optimized-lightweight-desktop)
- [**MATE - Popular Gnome 2 desktop**](../software/desktop/#mate-popular-gnome2-desktop)
- [**Xfce - Lightweight desktop**](../software/desktop/#xfce-lightweight-desktop)
- [**GnuStep - Alternative/unique desktop**](../software/desktop/#gnustep-alternativeunique-desktop)

### [Desktop Utilities](../dietpi-software-desktop/#desktop-utilities)
- [**Chromium - Web browser**](../dietpi-software-desktop/#chromium-web-browser)
- [**GIMP - Image editor**](../dietpi-software-desktop/#gimp-image-editor)
- [**QuiteRSS - RSS and Atom news feeds reader**](../dietpi-software-desktop/#quiterss-atom-news-feeds-reader)
### [Desktop Utilities](../software/desktop/#desktop-utilities)
- [**Chromium - Web browser**](../software/desktop/#chromium-web-browser)
- [**GIMP - Image editor**](../software/desktop/#gimp-image-editor)
- [**QuiteRSS - RSS and Atom news feeds reader**](../software/desktop/#quiterss-atom-news-feeds-reader)

## Remote Desktop Access
- [**TigerVNC Server - Desktop for remote connection**](../dietpi-software-remote-desktop/#29-tigervnc-server-desktop-for-remote-connection)
- [**TigerVNC Server - Desktop for remote connection**](../software/remote_desktop/#29-tigervnc-server-desktop-for-remote-connection)
- [RealVNC Server - Desktop for remote connection](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=80#p4149)
- [XRDP - Remote desktop server for Windows Remote Desktop Client](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=70#p2074)
- [NoMachine - Feature rich remote desktop connection](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=60#p2071)
Expand Down Expand Up @@ -80,7 +80,7 @@
- [Medusa - Automatically download TV shows](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=80#p3327)
- [Sonarr - Automatically download TV shows](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=100#p7455)
- [Radarr - Automatically download Movies](https://dietpi.com/phpbb/viewtopic.php?p=7457#p7457)
- **[Bazarr - Automatically download Subtitles for Sonarr/Radarr](../dietpi-software-bittorrent/#bazarr)**
- **[Bazarr - Automatically download Subtitles for Sonarr/Radarr](../software/bittorrent/#bazarr)**
- [Lidarr - Automatically download Music](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=130#p13580)
- [CouchPotato - Automatically download movies.](https://dietpi.com/phpbb/viewtopic.php?p=7212#p7212)
- [Jackett - API Support for your favourite torrent trackers.](https://dietpi.com/phpbb/viewtopic.php?p=7503#p7503)
Expand All @@ -105,7 +105,7 @@
## Cloud & Backup systems

- [ownCloud - Your own personal cloud based backup/data storage system](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5#p47)
- [**Nextcloud - Self-hosted productivity platform**](../dietpi-software-cloud/#nextcloud-self-hosted-productivity-platform)
- [**Nextcloud - Self-hosted productivity platform**](../software/cloud/#nextcloud-self-hosted-productivity-platform)
- [Nextcloud Talk - Video calls via Nextcloud, including TURN server](https://dietpi.com/phpbb/viewtopic.php?p=15227#p15227)
- [Pydio - Feature-rich backup and sync server with web interface.](https://dietpi.com/phpbb/viewtopic.php?p=1064#p1064)
- [UrBackup Server - Full backups for systems on your network](https://dietpi.com/phpbb/viewtopic.php?p=65#p65)
Expand Down
2 changes: 1 addition & 1 deletion docs/hardware-supported_sbc.md → docs/dietpi_sbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: DietPi Supported SBCs
## Raspberry Pi
The Raspberry Pi has sold more than 31 million units since it launched in 2012. Any Raspberry Pi can serve as a secondary computer for email and web surfing. The real fun starts when you use your Pi for projects, which can range from robots to retro arcade machines to home media servers, security cameras and so on.

You can install DietPi by following the step by step [Starting guide](../user-guide_install/).
You can install DietPi by following the step by step [Starting guide](../user-guide_install_sbc/).

<div class="md-typeset__table">
<table>
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ our images start at 400MB in size (3x lighter than 'Raspbian Lite'). With featur

## Getting started

If you are **new to DietPi**, the [_Install_](user-guide_install) provides a tutorial for everything you need to get DietPi running.
If you are **new to DietPi**, the [_Install_](user-guide_install_sbc) provides a tutorial for everything you need to get DietPi running.

If you **need help**, and have read through [_Getting Started_](user-guide_overview), check out [_Troubleshooting_](https://dietpi.com/phpbb/viewforum.php?f=11).

For more details visit the [_DietPi Community Forum_](https://dietpi.com/phpbb/viewforum.php?f=5).

## Easy to install popular software

You can **quickly and easily install popular software** ! All of them are **READY TO RUN** and optimised for your system. The list of available apps is long , and for the full list checkout [_DietPi Optimised Software_](user-optimised-software) page. Here are few highlights:
You can **quickly and easily install popular software** ! All of them are **READY TO RUN** and optimised for your system. The list of available apps is long , and for the full list checkout [_DietPi Optimised Software_](dietpi_optimised_software) page. Here are few highlights:

- Desktops (MATE/Xfce)
- Remote Desktop (VNC/NoMachine)
Expand All @@ -47,7 +47,7 @@ You can **quickly and easily install popular software** ! All of them are **READ
- Cloud/Backup (Nextcloud/Syncthing)
- Gaming (Amiberry/MineOS)
- Social, Surveillance, Hotspots, System Stats, Hardware Projects, Stacks (LAMP/LEMP), Pi-hole, VPN, File Servers, Home Automation and Printing
and [much more...](user-optimised-software)
and [much more...](dietpi_optimised_software)

DietPi does everything for you, giving you more time to enjoy the software you need.

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
- [NZBget - NZB download manager with web interface.](https://dietpi.com/phpbb/viewtopic.php?p=7575#p7575)
- [HTPC Manager - combines all your favourite software into one slick interface.](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=110#p8043)

[Return to the **Optimised Software list**](../user-optimised-software)
[Return to the **Optimised Software list**](../../dietpi_optimised_software)

## Bazarr

Expand All @@ -40,7 +40,7 @@ Key features:
=== "Quick start"
After installation access the web interface using port **6767** (ex: http://192.168.0.100:6767)

![Bazarr](assets/images/dietpi-software-download-bazarr.jpg)
![Bazarr](../assets/images/dietpi-software-download-bazarr.jpg)


=== "Advanced"
Expand Down
2 changes: 1 addition & 1 deletion docs/dietpi-software-camera.md → docs/software/camera.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
- [RPi Cam Control - RPi Camera / Web Interface Surveillance](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5#p48)
- [MotionEye - Camera / Web Interface Surveillance](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=100#p6610)

[Return to the **Optimised Software list**](../user-optimised-software)
[Return to the **Optimised Software list**](../../dietpi_optimised_software)
6 changes: 3 additions & 3 deletions docs/dietpi-software-cloud.md → docs/software/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
- [Minio - S3 compatible distributed object server](https://dietpi.com/phpbb/viewtopic.php?p=9121#p9121)
- [Firefox Sync Server - Sync bookmarks, tabs, history & passwords](https://dietpi.com/phpbb/viewtopic.php?p=24713#p24713)

[Return to the **Optimised Software list**](../user-optimised-software)
[Return to the **Optimised Software list**](../../dietpi_optimised_software)

??? info "How do I run **DietPi-Software** and install **Optimised software** ?"
To install any of the **DietPi Optimised Software** listed below run from the command line:
Expand All @@ -32,7 +32,7 @@

Choose **Software optimised** and select one or more items. Finally click on `Install`. DietPi will do all the necessary steps to install and start these software items.

![DietPi Software](assets/images/dietpi-software.jpg)
![DietPi Software](../assets/images/dietpi-software.jpg)

To see all the DietPi configurations options, review [DietPi Tools](../user-guide_tools) section.

Expand Down Expand Up @@ -75,4 +75,4 @@ Nextcloud gives you access to all your files wherever you are. Store your docume

[Nextcloud Website](https://nextcloud.com/athome/)

![DietPi-Software-NextCloud](assets/images/dietpi-software-cloud-nextcloud.jpg)
![DietPi-Software-NextCloud](../assets/images/dietpi-software-cloud-nextcloud.jpg)
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@

- [Folding@Home - Use processing power to assist with disease research](https://dietpi.com/phpbb/viewtopic.php?f=8&t=5&start=130#p13704)

[Return to the **Optimised Software list**](../user-optimised-software)
[Return to the **Optimised Software list**](../../dietpi_optimised_software)

Loading