Changes between Initial Version and Version 1 of Meetings/MacPortsMeeting2018/Documentation


Ignore:
Timestamp:
Mar 13, 2018, 11:05:04 AM (6 years ago)
Author:
neverpanic (Clemens Lang)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Meetings/MacPortsMeeting2018/Documentation

    v1 v1  
     1= Documentation
     2
     3== Documentation Location
     4We currently have documentation in a myriad of locations, such as
     5
     6 * the Guide
     7 * manpages
     8 * Trac wiki pages
     9 * website
     10
     11This situation is not ideal, since it is not clear which documentation goes where and creates inconsistencies between multiple locations.
     12
     13Multiple documentation locations ''may'' be justifiable, for example when separating user from developers documentation.
     14
     15We should move to a single location for documentation that is more easily editable than the guide currently is, but otherwise collects all information that is currently spread over the guide, wiki pages and the website.
     16
     17=== Improving the Installation User Experience
     18* The download page should auto-detect the user's operating system and already offer the correct download.
     19* To satisfy the need for a "one-line-copy-paste-auto-install" while avoiding the dreaded "curl | sudo sh", we could offer a single line similar to `xcode-select --install && curl -OL "$pkgurl" && sudo installer -packge "$pkgfile" -target /`
     20
     21== Documentation Content
     22* WIP