For experts instructions still attracts people who aren't experts

sugarlabs / sugar-docs

Documentation for Contributors and Developers

82 stars 103 forks source link

For experts instructions still attracts people who aren't experts #126

Open quozl opened 6 years ago

quozl commented 6 years ago

@iamutkarshtiwari reported difficulty following the native build instructions on Ubuntu 16.04;

did not know apt requires root; add sudo prefix,
did not know that apt build-dep requires deb-src lines added to /etc/apt/sources.list; add a reference to Ubuntu or Debian documentation or man sources.list.

It may be better to remove this section rather than have it duplicate documentation by GNU, Ubuntu, Debian, or Fedora.

Shivamgera commented 6 years ago

@quozl I would like to work on this issue.

quozl commented 6 years ago

That's great.

What's your experience level; what other technical documentation have you written.

Were you able to follow the native build instructions yourself? It is through being familiar with similar processes that you can isolate the essential details for others to use.

https://developer.sugarlabs.org/dev-environment.md.html#native%20sugar

Remember we do not want to fall into the trap of duplicating documentation by other projects, otherwise we will end up with old and wrong documentation.