Website simplification and Coq platform update. #162
Conversation
|
Note that for now, "Binary installers (Windows and macOS)" still link to the Coq GitHub release page, but we may need to update this to point to the Coq platform repository instead in the future. |
|
Another note is that we should get major user interfaces compatible with the Snap package (cf. coq-community/vscoq-legacy#46 for VsCoq) before actively recommending the Snap package like this update does. |
|
Also cc @CohenCyril: I point to Nix as an alternative advanced method and link to the nixpkgs-unstable manual. |
There was a problem hiding this comment.
Looks better. A variety of comments. Not sure I love the page layout though.
Would be fun to add a photo to add interest. How about this one (a free image from https://www.pexels.com/search/chicken/)?
Or this one for the Coq Community?
pages/index.html
Outdated
| However, to learn about Coq, it's best to start with a tutorial | ||
| or book. Go to our <a href="/documentation">documentation page</a> | ||
| for a list of such tutorials and books.</p> |
There was a problem hiding this comment.
| However, to learn about Coq, it's best to start with a tutorial | |
| or book. Go to our <a href="/documentation">documentation page</a> | |
| for a list of such tutorials and books.</p> | |
| However, to learn about Coq, we recommend starting with a tutorial | |
| or book, such as those listed on the <a href="/documentation">documentation page</a>. | |
| </p> |
"documentation page" is a bit of a dull name.
There was a problem hiding this comment.
"Resources" (a bit vague; libraries could be considered resources)?
How about "Learning more about Coq" or "Resources for Learning about Coq"?
I guess "Miscellaneous" and "Stuff" would not cut it :-).
pages/index.html
Outdated
| @@ -4,7 +4,7 @@ | |||
| <#include "incl/header.html"> | |||
|
|
|||
| <div class="framework"> | |||
| <div class="frameworklabel"><a style="color:black;font-weight:bold" href="/about-coq">What is Coq?</a></div> | |||
| <div class="frameworklabel"><a style="color:black;font-weight:bold" href="/documentation">Learn about Coq</a></div> | |||
There was a problem hiding this comment.
Would be nice to use bullet points for the typical applications--easier to scan
There was a problem hiding this comment.
Left as a to-do for later.
pages/index.html
Outdated
| <p>You don't need to install Coq to get started: run Coq in your browser using | ||
| <a href="https://jscoq.github.io">jsCoq</a>!</p> | ||
|
|
||
| <p>To go beyond, you can proceed to <a href="/download">install the | ||
| Coq platform</a> on your machine and | ||
| a <a href="user-interfaces.html">user interface</a> of your | ||
| choice.</p> |
There was a problem hiding this comment.
| <p>You don't need to install Coq to get started: run Coq in your browser using | |
| <a href="https://jscoq.github.io">jsCoq</a>!</p> | |
| <p>To go beyond, you can proceed to <a href="/download">install the | |
| Coq platform</a> on your machine and | |
| a <a href="user-interfaces.html">user interface</a> of your | |
| choice.</p> | |
| <p>You don't need to install Coq to get started: you can run Coq in your browser using | |
| <a href="https://jscoq.github.io">jsCoq</a>!</p> | |
| <p>Eventually you'll probably want to <a href="/download">install the Coq platform</a> | |
| on your system with a <a href="user-interfaces.html">user interface</a> of your choice. | |
| </p> |
I expect most people would eventually install Coq on their own system. Is that right? Can we give a sentence saying why users will want to install on their system--what added features, etc.?
BTW, I find it very hard to pick out the links in the text. Can you change the highlight color for all the links to something more vivid?
There was a problem hiding this comment.
I expect most people would eventually install Coq on their own system. Is that right? Can we give a sentence saying why users will want to install on their system--what added features, etc.?
That's right. Getting Coq installed gives you a proper way to conduct projects with multiple files, gives you access to faster reduction machines, etc.
BTW, I find it very hard to pick out the links in the text. Can you change the highlight color for all the links to something more vivid?
Again a design issue. I'd rather not touch that in this PR, especially as @maximedenes is planning to prepare a refresh of the design website.
There was a problem hiding this comment.
If you're willing to ask Maxime and he's O with it, you could increase the red level. Should be one line in a CSS file. It would affect all pages in the website. The links are barely discernable--it's an easy way to make it a lot more usable.
If I may offer an opinion, it would nice if the developers were invited to offer suggestions on the website (but probably leaving the decisions to Maxime). Also incremental improvement and review is a superior to the "waterfall" development model (both for websites and software).
|
Many thanks for the update! |
A "refresh" of the webpage style was planned by @maximedenes (to be outsourced to professionals). |
|
@Zimmi48 FYI the snap package page has a button to generate html code for pointing to the package (a badge). Maybe it's not good for this page, but if you decide to make sub pages, then it may have its place. Maybe I'm the only one that sees it being admin, in that case I can give you the pwd to look at the preview. |
|
@Zimmi48 : one thought: should we put this online before a Coq Platform 8.13.0.0 is published? I had a discussion on this with @gares. Essentially the options are:
Since we are in a transitional situation I would tend to the first option, but @gares preferred the second. I think we both don't have very strong opinions on this, but this should be coordinated with this PR. |
I noticed it but it looked too heavy for this page. |
I would also prefer the first option. |
|
One thing I don't like much is to have two platforms for the same coq release with different feature sets. The 4th digit becomes very important then, to answer the question "is package X in the platform for 8.13". This is probably why I preferred option 2, but it goes in hand with the meaning of that digit. And for the records, I'm also a bit skeptical about inheriting the third digit from Coq (what 8.13.1.0 means? does it have the same features of 8.13.0.1 or 8.13.0.0?) |
+1 |
The idea is that the content only ever increases, so that 8.13.1.0 will have the same or larger content than 8.13.0.1. We just need some efficient way to add packages without delaying this too long and it is not unlikely that the Coq platform will need more maintenance releases than Coq itself - that's the reason for the 4th digit. What I plan is to have one more level (the first question the script asks, coq only, ide or full) called "extended", but I didn't plan as yet what goes in what level and if "full" should be renamed to "standard" or "default". |
|
Yes, the standard vs extended set is a good idea. I agree with the versioning scheme concern, but we should probably move this discussion somewhere else -> coq/platform#22. |
|
FWIW, one way to facilitate reviewing website updates is to temporarily make the new material available on a non-standard TCP port or under a different DNS name, which reviewers can include in their URL while others won't find it. This may be easy or way too much work depending on the web site technology. |
Unfortunately, the current infrastructure is a big mess. So this is not an option until it is replaced by something simpler. But reviewers can also check out the branch and run |
I like this idea but consider it part of design, so to keep for later. |
|
I noticed 2 other typos in documentation.html: ressources |
Apply suggestions from code review Co-authored-by: Jim Fehrle <[email protected]>
Zimmi48
force-pushed
the
coq-platform-update
branch
from
764f758 to
b2456b1
Compare
|
@gares PR updated. Two remarks:
|
|
Following @MSoegtropIMC remark, I will update the PR to point to https://github.com/coq/platform/releases rather than https://github.com/coq/platform. |
Zimmi48
force-pushed
the
coq-platform-update
branch
from
b2456b1 to
965270d
Compare
|
Done.
It would also be natural to include the complete list of packages and their versions in the release notes. |
|
@Zimmi48 : yes, I can definitely improve on the release notes. Currently CI for the version bumping + readme adjustment PR is running, so I will do the tag tomorrow. It would be great if we could discuss the release message tomorrow morning. |
|
With the change of default branch, it doesn't seem as useful as before to point to the releases section rather than the main repo page, so I'll revert this update to the previous version and merge. |
Zimmi48
force-pushed
the
coq-platform-update
branch
from
965270d to
b2456b1
Compare
This is a major update to the website home page and Coq installation pages to put the focus on the Coq platform installation method (cc @gares @MSoegtropIMC). It also reduces the importance of the current version number on the website in relation with CEP#52 (but we still need it, mostly in the opam using page). For the homepage, I also tried to think at what we would like to put forward if the design of the website was reworked, but without doing any change to the design yet.
The diff for the index page and the download page might be a bit hard to follow, so here are some preview screenshots:
cc @jfehrle (I cannot request a review from you on this repository)