Opened 3 years ago
Closed 3 years ago
#29496 closed enhancement (fixed)
Update README.md and Installation Guide
Reported by: | Matthias Köppe | Owned by: | |
---|---|---|---|
Priority: | blocker | Milestone: | sage-9.1 |
Component: | documentation | Keywords: | |
Cc: | Dima Pasechnik, John Palmieri, Frédéric Chapoton, Isuru Fernando, Volker Braun | Merged in: | |
Authors: | Matthias Koeppe, Dima Pasechnik | Reviewers: | Dima Pasechnik, Matthias Koeppe |
Report Upstream: | N/A | Work issues: | |
Branch: | 172afc1 (Commits, GitHub, GitLab) | Commit: | 172afc1c416e066320f1c2eb4ffabc51e486fd6c |
Dependencies: | Stopgaps: |
Description (last modified by )
These need to be updated to reflect the installation changes in 9.1.
As the same time, we do some overdue updates (e.g., remove mention of Solaris) and remove some duplication to simplify maintenance.
Related issues:
- Website updates:
[x] https://github.com/sagemath/website/pull/187 - Get rid of links to download-packages.html
- Should remove outdated, duplicated, misleading material at wiki.sagemath.org or mark as outdated:
[x] https://wiki.sagemath.org/SupportedPlatforms (marked as outdated)
Change History (26)
comment:1 Changed 3 years ago by
Branch: | → u/mkoeppe/update_readme_md_and_installation_guide |
---|
comment:2 follow-up: 4 Changed 3 years ago by
Commit: | → 5832ab063b08dee96ad6aca065ae3a3be46cdff4 |
---|
comment:3 Changed 3 years ago by
Commit: | 5832ab063b08dee96ad6aca065ae3a3be46cdff4 → a23d56e95ac83f049ac66ef3ad765bd35dd574ff |
---|
Branch pushed to git repo; I updated commit sha1. New commits:
a23d56e | README.md: Restore mention of porting to other platforms
|
comment:4 Changed 3 years ago by
Replying to dimpase:
the last 2 lines ought to stay, IMHO.
Re-added, re-worded.
Wiki may be mentioned with a caveat that that info may be severely outdated.
It will be easy to add links to up to date information to README if that becomes available.
comment:5 Changed 3 years ago by
https://wiki.sagemath.org/Distribution is one of the few useful wiki pages.
We should link to it from the installation manual, and remove duplication.
comment:6 Changed 3 years ago by
Cc: | Isuru Fernando added |
---|
comment:7 Changed 3 years ago by
By the way, I have prepared https://wiki.sagemath.org/ReleaseTours/sage-9.1
comment:8 Changed 3 years ago by
Authors: | → Matthias Koeppe |
---|
comment:9 Changed 3 years ago by
Cc: | Volker Braun added |
---|
comment:11 Changed 3 years ago by
Status: | new → needs_review |
---|
comment:12 follow-up: 13 Changed 3 years ago by
"1. Optional: Read this if you are intending to run a Sage notebook server for multiple users. For security (i.e., to run notebook(secure=True)`) you want to access the server using the HTTPS protocol. First, install OpenSSL and the OpenSSL development"
is this referring to the outdated notebook?
comment:13 Changed 3 years ago by
Replying to mkoeppe:
"1. Optional: Read this if you are intending to run a Sage notebook server for multiple users. For security (i.e., to run notebook(secure=True)`) you want to access the server using the HTTPS protocol. First, install OpenSSL and the OpenSSL development"
is this referring to the outdated notebook?
Oh yes, this should be removed,it's about sagenb
comment:14 Changed 3 years ago by
Commit: | a23d56e95ac83f049ac66ef3ad765bd35dd574ff → b98f7ddef87cba3e68f08097c1062380e595d71b |
---|
Branch pushed to git repo; I updated commit sha1. New commits:
b98f7dd | README.md: Do not mention the notebook
|
comment:15 Changed 3 years ago by
Commit: | b98f7ddef87cba3e68f08097c1062380e595d71b → f7d9b28aa3a66f9be69548d252f757ef8178378f |
---|
Branch pushed to git repo; I updated commit sha1. New commits:
f7d9b28 | README.md: Some updates on 'configure'
|
comment:16 Changed 3 years ago by
I'll stop here but there are obvious ways to improve it even further.
- There should not be both "Quick Instructions" and "More Detailed Instructions" in here. Should be merged & links to install manual added.
comment:17 Changed 3 years ago by
Description: | modified (diff) |
---|
comment:18 follow-up: 19 Changed 3 years ago by
There is some special hell related to OpenSSL on MacOS. Perhaps it should be said in README.
comment:19 Changed 3 years ago by
Replying to dimpase:
There is some special hell related to OpenSSL on MacOS. Perhaps it should be said in README.
I think this is not a problem when any system python3 is used.
comment:20 Changed 3 years ago by
please see some fixes here: https://gitlab.com/dimpase/sage/-/commit/a6befb26cff1640aee33ed7f27c8a796ee27b85a
comment:21 Changed 3 years ago by
All nice. Please push them to the ticket.
For Cygwin, can also refer to the installation manual. There’s a section on Cygwin now
comment:22 Changed 3 years ago by
Branch: | u/mkoeppe/update_readme_md_and_installation_guide → public/readme91 |
---|---|
Commit: | f7d9b28aa3a66f9be69548d252f757ef8178378f → 172afc1c416e066320f1c2eb4ffabc51e486fd6c |
Reviewers: | → Dima Pasechnik |
Status: | needs_review → positive_review |
comment:24 Changed 3 years ago by
Authors: | Matthias Koeppe → Matthias Koeppe, Dima Pasechnik |
---|---|
Reviewers: | Dima Pasechnik → Dima Pasechnik, Matthias Koeppe |
comment:25 Changed 3 years ago by
Priority: | major → blocker |
---|
comment:26 Changed 3 years ago by
Branch: | public/readme91 → 172afc1c416e066320f1c2eb4ffabc51e486fd6c |
---|---|
Resolution: | → fixed |
Status: | positive_review → closed |
I don't like full removal of
the last 2 lines ought to stay, IMHO. Wiki may be mentioned with a caveat that that info may be severely outdated.
New commits:
README.md: Do not mention Solaris, remove link to outdated wiki
README.md: Add ./configure to install instructions