#12229: Add section in the developers manual about sagenb development
---------------------------------+------------------------------------------
Reporter: jdemeyer | Owner: mvngu
Type: enhancement | Status: needs_work
Priority: blocker | Milestone: sage-5.2
Component: documentation | Resolution:
Keywords: | Work issues:
Report Upstream: N/A | Reviewers: William Stein, Jeroen
Demeyer, Punarbasu Purkayastha, Karl-Dieter Crisman
Authors: Jason Grout | Merged in:
Dependencies: | Stopgaps:
---------------------------------+------------------------------------------
Comment (by kini):
Replying to [comment:36 kcrisman]:
> Okay, I have a few questions. Mostly this is because of the annoying
autogenerated thing this is from.
I agree about it being annoying - why are we using an autogenerated thing,
anyway? Our mercurial docs aren't autogenerated.
> * The file `this_project.inc` has
> {{{
> .. Sage Notebook
> .. _`Sage Notebook`: http://sagemath.org
> .. _`Sage Notebook github`: http://github.com/sagemath/sagenb
>
> .. _`Sage Notebook mailing list`: http://groups.google.com/group/sage-
notebook
> }}}
> but I doubt we want the Sage notebook site to be sagemath.org, as
there are a number of links to this. What is the best "generic" Sage
notebook URL?
Well, ideally it is http://nb.sagemath.org/ , but that page is extremely
outdated right now. Someone should update it.
> * I don't understand why there are several references to sending files
to the Sage notebook devel list. That is really not at all what we want
it to do! So what ''do'' we want it to do? Surely not to upload to Trac
;-)
> * "Hardcore forking action" is semi-offensive and unfortunately part of
the old crude hacking humor thing. We should delete it.
Those actual words appear on github when you fork a repository, by the
way.
> * There is a lot of reference to just sagenb, but in reality one might
want it to be inside the devel directory (well, or whatever happens in the
"new" Sage tree someday).
Once the whole Sage tree switches to git (#13015), this autogenerated
stuff will be even less adequate. At least now it seems that most sagenb
contributors are fairly experienced at contributing to open source
projects. That is not true of sage library contributors.
> My recommendation: make it '''really really obvious''' that this is
absolutely generic documentation, and fix the things above. This should
all be doable in index.rst and a few other places. I can do some of
this, but am not sure what the answers to the first two questions are.
>
> Also, although this should still be a blocker for whatever release the
new Sage notebook goes in, I don't think that the new notebook should
depend on it; we want people testing it as soon as possible. By the way,
once the new notebook goes in, do we still need the removal and recreation
of the symlink? I guess so...
You mean the symlink `$SAGE_ROOT/devel/sagenb`? Of course not :)
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/12229#comment:38>
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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
