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

[Feature Request]: Documentation naming #306

Open
igorpecovnik opened this issue Dec 5, 2024 · 0 comments
Open

[Feature Request]: Documentation naming #306

igorpecovnik opened this issue Dec 5, 2024 · 0 comments
Labels
Feature Request Feature suggestion

Comments

@igorpecovnik
Copy link
Member

igorpecovnik commented Dec 5, 2024

Which feature would you like to have?

Automated documentation is handy features, but direct translation from command structure doesn't look perfect What do I mean by that?

image

Section could be organised this way:

Release management

  • stable
  • rolling

image

into:

image

Which means commands inside section would be without anchor. External link goes always to a section.

***

## ZFS filesystem

| Author | Maintainer | Status |
| -------- | -------- | -------|
| @armbian | @armbian | Stable |


<!--- section image START from tools/include/images/SY018.png --->
[![ZFS filesystem - enable support](/images/SY018.png)](#)
<!--- section image STOP from tools/include/images/SY018.png --->

ZFS supports storage pools with varying levels of data redundancy. When a bad data block is detected, ZFS fetches the correct data from another redundant copy and repairs the bad data, replacing it with the correct data.

**Install:**
~~~
armbian-config --cmd SY018
~~~

**Remove:**
~~~
armbian-config --cmd SY019
~~~

=== "Useful ZFS commands"

    - zpool
    - zfs


***

Possible final design of section:

image

@igorpecovnik igorpecovnik added the Feature Request Feature suggestion label Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Request Feature suggestion
Projects
None yet
Development

No branches or pull requests

1 participant