user-docs issueshttps://gitlab.nic.cz/turris/user-docs/-/issues2019-09-02T22:35:18+02:00https://gitlab.nic.cz/turris/user-docs/-/issues/41Cover first setup of Turris Omnia and Turris 1.X2019-09-02T22:35:18+02:00Michal HruseckyCover first setup of Turris Omnia and Turris 1.XBootstrapMichal HruseckyMichal Hruseckyhttps://gitlab.nic.cz/turris/user-docs/-/issues/42Describe how to configure Firewall via LuCI2020-10-12T14:02:33+02:00Michal HruseckyDescribe how to configure Firewall via LuCIhttps://gitlab.nic.cz/turris/user-docs/-/issues/43add GPT info to doc.turris.cz/doc/en/howto/omnia_booting_from_external_storage2019-08-19T20:45:41+02:00Ghost Useradd GPT info to doc.turris.cz/doc/en/howto/omnia_booting_from_external_storagewith GPT support in the `u-boot` implementation being absent in downstream OpenWrt / TOS it would be helpful to mention such in the article since booting from a GPT disk does not work.with GPT support in the `u-boot` implementation being absent in downstream OpenWrt / TOS it would be helpful to mention such in the article since booting from a GPT disk does not work.https://gitlab.nic.cz/turris/user-docs/-/issues/44Release new documentation2019-09-07T07:30:44+02:00Michal HruseckyRelease new documentationMake sure that it is publicly deployed. Related to #25 and can be released after everything from %Bootstrap is finished.Make sure that it is publicly deployed. Related to #25 and can be released after everything from %Bootstrap is finished.Bootstraphttps://gitlab.nic.cz/turris/user-docs/-/issues/45Describe interesting features2019-10-22T11:52:50+02:00Michal HruseckyDescribe interesting featuresWrite an overview page that would explain cool features our router has and point to other articles to read more - like Pakon, Nextcloud, Netmetr, VPN, ...Write an overview page that would explain cool features our router has and point to other articles to read more - like Pakon, Nextcloud, Netmetr, VPN, ...Michal HruseckyMichal Hruseckyhttps://gitlab.nic.cz/turris/user-docs/-/issues/46Foris introduction2021-05-18T16:02:49+02:00Michal HruseckyForis introductionCreate an introductionary article for Foris stating what is it all about and why is it needed. Something to start with before going into specific settings.Create an introductionary article for Foris stating what is it all about and why is it needed. Something to start with before going into specific settings.Basics2020-10-16https://gitlab.nic.cz/turris/user-docs/-/issues/47Guide for statistics graphs2021-06-04T10:11:39+02:00Vojtech MyslivecGuide for statistics graphsThere is a possibility to enable statistics graphs in LuCI. These packages are preinstalled AFAIK and it is needed just to enable it and tune a configuration a bit.
It is really valuable information to monitor device load (like CPU, mem...There is a possibility to enable statistics graphs in LuCI. These packages are preinstalled AFAIK and it is needed just to enable it and tune a configuration a bit.
It is really valuable information to monitor device load (like CPU, memory and network bandwidth) and we should guide the users to get these information as soon as possible.https://gitlab.nic.cz/turris/user-docs/-/issues/48Inform users that this is Turris 4.0+ documentation and document how to found...2019-10-21T14:51:11+02:00Karel KociInform users that this is Turris 4.0+ documentation and document how to found out if it applies to them* [x] Add warning to title page
* [x] Write article about how to found out what version of Turris OS user is running
* [x] Extend model page with info about factory TOS versions for different revisions* [x] Add warning to title page
* [x] Write article about how to found out what version of Turris OS user is running
* [x] Extend model page with info about factory TOS versions for different revisionshttps://gitlab.nic.cz/turris/user-docs/-/issues/49Polish changelog page2022-11-07T11:27:41+01:00Michal HruseckyPolish changelog pageWould be nice if Changelog page would be somehow nicer - better formatted, links in right navigation bar and such.Would be nice if Changelog page would be somehow nicer - better formatted, links in right navigation bar and such.https://gitlab.nic.cz/turris/user-docs/-/issues/50Document most common error scenarios2019-10-22T11:52:52+02:00Michal HruseckyDocument most common error scenariosFor support purposes write down a page with common problems and how to resolve them.For support purposes write down a page with common problems and how to resolve them.Michal HruseckyMichal Hruseckyhttps://gitlab.nic.cz/turris/user-docs/-/issues/51Document public DynFW:Publisher API2021-05-18T15:58:51+02:00Vojtech MyslivecDocument public DynFW:Publisher APIRelates to #64
From projects turris/sentinel/dynfw-example-client> and turris/sentinel/dynfw>Relates to #64
From projects turris/sentinel/dynfw-example-client> and turris/sentinel/dynfw>Sentinel migrationhttps://gitlab.nic.cz/turris/user-docs/-/issues/52Small typo in MOX first steps2019-10-16T15:01:55+02:00Jindrich SkacelSmall typo in MOX first stepsI wanted to create merge request, but I am not able to do it. So I will just write it here.
There is typo in word "conputer" in https://gitlab.labs.nic.cz/turris/user-docs/blob/master/docs/basics/first-setup/mox_first_setup.md on line 4...I wanted to create merge request, but I am not able to do it. So I will just write it here.
There is typo in word "conputer" in https://gitlab.labs.nic.cz/turris/user-docs/blob/master/docs/basics/first-setup/mox_first_setup.md on line 45 in master branch :)https://gitlab.nic.cz/turris/user-docs/-/issues/53Migrate weblate guide2020-08-11T15:40:15+02:00Karel KociMigrate weblate guideIn old documentation we have very nice article about weblate usage. We should migrate it to new documentation as part of contribution guides.
https://wiki.turris.cz/doc/en/howto/localisationIn old documentation we have very nice article about weblate usage. We should migrate it to new documentation as part of contribution guides.
https://wiki.turris.cz/doc/en/howto/localisationLukas JelinekLukas Jelinekhttps://gitlab.nic.cz/turris/user-docs/-/issues/54Nextcloud: add info about trusted domains2021-09-22T11:37:39+02:00Jan PavlinecNextcloud: add info about trusted domainsWe should document how to disable trusted domains in nextcloud and describe what are potential risks.We should document how to disable trusted domains in nextcloud and describe what are potential risks.Jan PavlinecJan Pavlinec2020-10-16https://gitlab.nic.cz/turris/user-docs/-/issues/55Add article about supported HW2020-10-13T19:35:43+02:00Michal HruseckyAdd article about supported HWDescribe how HW support works and link to community wikiDescribe how HW support works and link to community wikiMichal HruseckyMichal Hruseckyhttps://gitlab.nic.cz/turris/user-docs/-/issues/56The "Early access" page is somewhat inconsistent2020-03-05T13:46:00+01:00Christian RavnThe "Early access" page is somewhat inconsistent**TLDR:** The current release descriptions are confusing and could benefit from an overhaul focusing on making it more consistent, especially in regards to what "stable" means for each release.
## Long version
I think the current b...**TLDR:** The current release descriptions are confusing and could benefit from an overhaul focusing on making it more consistent, especially in regards to what "stable" means for each release.
## Long version
I think the current branching strategy leads to a bit of confusion. I don't know if that's because I'm misunderstanding the description of each branch or because there's an underlying issue, so I'll try to describe how I interpret the workflow and how I think communication about it could be improved. Please let me know if any of my points are due to a misunderstanding on my end :slight_smile:
Below is my understanding of [the workflow](https://gitlab.labs.nic.cz/turris/turris-build/blob/hbk/WORKFLOW.adoc) and [the docs](https://docs.turris.cz/geek/testing/). The "dev changes" columns describes, what the criteria there is for a change to be included. Upstream is which version of upstream is included in that build.
| | Dev changes | Upstream |
| -------------- |:------------------|:-----|
| hbs :snail: | Stable | Target version |
| hbt :turtle: | Next release | Target version |
| hbk :cat: | Feature complete| Latest Stable |
| hbl :lion: | Latest | Latest Stable |
| hbd :dragon_face: | Latest + WIP | Master |
It was difficult for me to come up with precise definitions, especially for the upstream column. As an example, both :lion: and :cat: are described as having the latest stable upstream, but use different versions of OpenWrt.
At the same time there's the references to semantic versioning which is not reflecting the actual builds (:lion: is described as next minor build (0.x.0), but is currently the next major (x.0.0).
The combination of these things makes it difficult to predict, what I'll end up with for each of the branches and what the purpose of each of them are.
As far as I can understand, the biggest issue is, that each branch is trying to version two sources in a single piece of information.
## Proposal
A solution could be to assign separate animals to OpenWrt and dev changes, then define the branch by the scariest animal. It might be a good idea to assign two animals to OpenWrt - one based on the upstream tag and one for how well it runs with TOS.
### Examples
Master branch of OpenWrt and master dev changes will have zoo version:
OpenWrt (:dragon_face: , :dragon_face:) -> :dragon_face:, Dev changes :dragon_face:, Result: hbd
Current stable OpenWrt and latest stable features:
OpenWrt (:snail:, :lion:) -> :lion:, Dev changes: :cat:, Result: hbl
I understand it requires resources to implement these kind of things in a deployment pipeline and keep the docs up to date. However from an end-users perspective it's currently hard to understand what is meant by "stable" in the docs and what software will actually end up on my device based on my choice of branch.https://gitlab.nic.cz/turris/user-docs/-/issues/57Community translations2020-10-26T10:48:27+01:00Karel KociCommunity translationsWe could provide community translated documentation. This doesn't mean that we should tell users that it is authoritative but we could allow users to translate it somehow.
The idea is to use same framework as rest of our tools that mean...We could provide community translated documentation. This doesn't mean that we should tell users that it is authoritative but we could allow users to translate it somehow.
The idea is to use same framework as rest of our tools that means weblate. That means we have to generate pot files from our markdown and later on translate it.
Example of script and project doing that is https://github.com/tvheadend/tvheadend-documentation/blob/master/tvhmd.pyhttps://gitlab.nic.cz/turris/user-docs/-/issues/58How to configure VLANs2021-05-18T15:58:46+02:00Josef SchlehoferHow to configure VLANs2020-10-16https://gitlab.nic.cz/turris/user-docs/-/issues/59Add article for LTE pack2023-08-29T11:09:47+02:00Josef SchlehoferAdd article for LTE packConsist of two actions
- [ ] Add: page to `hw/omnia` section dedicated to add-ons
- [ ] Add: page to `geek` section setting up the LTE in LUCIConsist of two actions
- [ ] Add: page to `hw/omnia` section dedicated to add-ons
- [ ] Add: page to `geek` section setting up the LTE in LUCIFilip HronFilip Hronhttps://gitlab.nic.cz/turris/user-docs/-/issues/60NAS article2020-10-12T14:24:32+02:00Josef SchlehoferNAS articleSimilar to this one: https://doc.turris.cz/doc/en/howto/nasSimilar to this one: https://doc.turris.cz/doc/en/howto/nas2020-10-16