#18405: Cleanup in the 'installation' manual
-----------------------------+---------------------------------
Reporter: ncohen | Owner:
Type: enhancement | Status: new
Priority: major | Milestone: sage-6.7
Component: documentation | Keywords:
Merged in: | Authors: Nathann Cohen
Reviewers: | Report Upstream: N/A
Work issues: | Branch:
Commit: | Dependencies:
Stopgaps: |
-----------------------------+---------------------------------
The installation manual is the first thing I get when I type 'install
Sage' in
Google. And from that manual, it is not totally obvious how Sage should be
installed (especially from its sources). Read it and see how hard it is to
get
the basic info, like 'what to download' and 'what to type'
This branch tries to clean that manual a bit, mostly by moving things
around,
making lengthy explanations shorter and adding table of contents where one
is
needed.
In particular:
- There is no need of a section about how to build the doc in this manual.
It is
already explained somewhere else (in the developer's manual), and the
doc is
already built when you install Sage anyway.
- The section on SageTex is being moved to the (already existing)
tutorial/sagetex document. Indeed:
- Something as specific as 'how to configure Sagetex' does not belong to
a
document explaining how Sage should be installed (many packages
require
specific configuration, e.g. CPLEX,Gurobi,dot2tex,...)
- Many links from the SageTex tutorial are broken if no internet
connection is
available, as they point directly to the online 'installation'
manual. Besides, they point to the index and not to the actual install
page.
http://www.sagemath.org/doc/tutorial/sagetex.html
- Some information is repeated in both documents (which usually leads to
only
one of the two being updated)
- 'Desktop icon' is renamed to 'KDE Desktop icon'. Though I do not
personally
believe that it is Sage's role to explain how to customize KDE.
- The 'introduction' section is merged with the 'index' page. Most of that
section is actually a list of Sage's standard packages, and so this
section
has been renamed to 'standard packages'. Something will have to be done
with
this section later, see
https://groups.google.com/d/topic/sage-devel/aEmUmFOwJYQ/discussion
--
Ticket URL: <http://trac.sagemath.org/ticket/18405>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
