Ticket #4809 (closed enhancement: fixed)

Opened 4 years ago

Last modified 4 years ago

[with patch, positive review] the installation guide and constructions guide should be CC licensed

Reported by: ddrake Owned by: ddrake
Priority: major Milestone: sage-3.4.2
Component: documentation Keywords:
Cc: Work issues:
Report Upstream: Reviewers:
Authors: Merged in:
Dependencies: Stopgaps:

Description

Our documentation should be clearly licensed.

15:09 < hampton|home> what is the license of the sage documentation?
15:09 < hampton|home> is it a type of creative commons?
15:11 < ddrake> hrm, I dunno. It should be, I think.
15:13 < ddrake> yep: by-sa
15:13 < ddrake> http://sagemath.org/doc/tut/node1.html
15:14 < hampton|home> that's the tutorial - are they are under that?
15:14 < hampton|home> the others don't have a notice I think
15:14 < ddrake> the installation guide and constructions don't have a notice
15:15 < ddrake> ref manual is attribution-sharealike
15:15 < ddrake> programming guide too
15:15 < hampton|home> cool, thanks

Attachments

trac_4809_constructions.patch Download (690 bytes) - added by ddrake 4 years ago.
trac_4809_installation.patch Download (659 bytes) - added by ddrake 4 years ago.
trac_4809_other.patch Download (2.7 KB) - added by jhpalmieri 4 years ago.

Change History

comment:1 Changed 4 years ago by mabshoff

  • Milestone set to sage-3.4

comment:2 Changed 4 years ago by ddrake

The attached patches license the constructions guide and installation guide as CC Attribution-Sharealike, which is the same as the other Sage documentation. Since David Joyner is listed as the/an author of both documents, I suppose he should approve or sign off on these patches.

comment:3 Changed 4 years ago by ddrake

  • Summary changed from the installation guide and constructions guide should be CC licensed to the installation guide and constructions guide should be CC licensed [with patch, needs review]

comment:4 Changed 4 years ago by wdj

  • Summary changed from the installation guide and constructions guide should be CC licensed [with patch, needs review] to the installation guide and constructions guide should be CC licensed [with patch, needs work]

Actually, href will not work for a few reasons.

(1) The href (or whatever it's called) package is commented out, so it won't compile.

(2) But I think the href latex package somehow conflicts with the Python doc latex package (?), and uncommenting it doesn't work either. (After moving to rest/sphinyx is this an issue?)

The solution is easy though - use \url{...} instead. It is used in other places in const.tex and inst.tex as well. If you just swap href with url it compiles fine and I'll give this a positive review.

comment:5 Changed 4 years ago by mabshoff

  • Summary changed from the installation guide and constructions guide should be CC licensed [with patch, needs work] to [with patch, needs work] the installation guide and constructions guide should be CC licensed

Changed 4 years ago by ddrake

Changed 4 years ago by ddrake

comment:6 Changed 4 years ago by ddrake

  • Summary changed from [with patch, needs work] the installation guide and constructions guide should be CC licensed to [with patch, needs review] the installation guide and constructions guide should be CC licensed

Updated versions of the patches for the spinx-ified documentation.

comment:7 Changed 4 years ago by jhpalmieri

trac_4809_constructions.patch and trac_4809_installation.patch are ready to go: positive review. Meanwhile, I can't find any license information for the tutorial, reference manual, or developer's guide. Did they disappear in the Sphinx conversion? Here's a new patch which adds them. It also removes the line "Contents:" from various index.rst files -- if you produce a PDF from the docs, the table of contents is printed first, then whatever is in index.rst, so you would end up with an introduction followed by "Contents:", and then the rest of the page was blank.

Changed 4 years ago by jhpalmieri

comment:8 Changed 4 years ago by ddrake

  • Owner changed from tba to ddrake
  • Status changed from new to assigned
  • Summary changed from [with patch, needs review] the installation guide and constructions guide should be CC licensed to [with patch, positive review] the installation guide and constructions guide should be CC licensed
  • Milestone changed from sage-4.0 to sage-3.4.2

We should definitely license the rest of the documentation, too. Positive review to trac_4809_other.patch.

I'll also open a French version of this ticket. I'm sure I could cut and paste something into the French tutorial, but I'll let one of our Francophone developers handle that.

I'm changing the milestone to 3.4.2 since these are not big or invasive patches, and should get in as soon as possible.

comment:9 Changed 4 years ago by mabshoff

  • Status changed from assigned to closed
  • Resolution set to fixed

Merged all three patches in Sage 3.4.2.alpha0.

Cheers,

Michael

Note: See TracTickets for help on using tickets.