#19 Lack of good documentation

Open
opened 1 year ago by RISCI_ATOM · 4 comments

The libreCMC has had a lack of documentation for most of the project's life due to lack of time and upstream docs being non-free (CC-BY-NC-SA) or tainted with documentation from the same / similar source.

libreCMC documentation needs to be cleanly written and can't be tainted with non-free documentation (all docs should be licensed CC-BY-SA). The reason this is a concern is because vendors who sell devices with libreCMC need to be able to distribute or reuse documentation that libreCMC should be providing.

The libreCMC has had a lack of documentation for most of the project's life due to lack of time and upstream docs being non-free (CC-BY-NC-SA) or tainted with documentation from the same / similar source. libreCMC documentation needs to be cleanly written and can't be tainted with non-free documentation (all docs should be licensed CC-BY-SA). The reason this is a concern is because vendors who sell devices with libreCMC need to be able to distribute or reuse documentation that libreCMC should be providing.

I would like to contribute some docs, what is the most needed docs?

I would like to contribute some docs, what is the most needed docs?
ullbeking commented 1 year ago

@jonasbits2, a good start is by identifying the things that you find confusing. For example, here's a question that I didn't understand until @jxself explained it to me repeatedly:

What is the difference between "factory" and "sysupgrade" images? When would I use one over the other? I'm still trying to figure out how to express an answer...

@jonasbits2, a good start is by identifying the things that you find confusing. For example, here's a question that I didn't understand until @jxself explained it to me repeatedly: What is the difference between "factory" and "sysupgrade" images? When would I use one over the other? I'm still trying to figure out how to express an answer...
pi31415 commented 1 year ago

Two questions:

Two questions: - How does one edit the wiki? - Is there any reason text can't be copied and pasted from docs like <https://lede-project.org/docs/user-guide/introduction_to_lede_configuration> where it is labeled "CC Attribution-Share Alike 4.0 International"? It would only require about 4 minor edits to convert from LEDE to librecmc.
RISCI_ATOM commented 1 year ago
Collaborator

1) Fork and make a pull request against https://gogs.librecmc.org/libreCMC/libreCMC-wiki

2) The concern is that some LEDE documentation is still tainted with stuff pulled from the OpenWRT wiki (which is licensed CC-NC-BY). I don't want to run the risk of tainting libreCMC with it.

1) Fork and make a pull request against https://gogs.librecmc.org/libreCMC/libreCMC-wiki 2) The concern is that some LEDE documentation is still tainted with stuff pulled from the OpenWRT wiki (which is licensed CC-NC-BY). I don't want to run the risk of tainting libreCMC with it.
Sign in to join this conversation.
Loading...
Cancel
Save
There is no content yet.