Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes to the CellML 2.0 Specification page #302

Open
3 of 4 tasks
agarny opened this issue Apr 17, 2020 · 11 comments
Open
3 of 4 tasks

Changes to the CellML 2.0 Specification page #302

agarny opened this issue Apr 17, 2020 · 11 comments

Comments

@agarny
Copy link
Contributor

agarny commented Apr 17, 2020

Some small changes to the CellML 2.0 Specification page:

  • Replace "The 'what has changed document' describes the changes between this version of CellML and the previous CellML 1.1." with "The release notes describe the changes between CellML 1.1 and this version of CellML." (and make "release notes" a link)?
  • "For the general[,] reader the informative specification is"
  • Make sure that our link to libCellML works. Right now, it points to https://libcellml.org/, which doesn't resolve.
    - [ ] Remove the "CellML 2.0 Drafts" section? I don't see the point in making that page unnecessarily "complicated" by keeping things that people should never have a chance to refer.
  • What is the correct link for the informative rendering of the spec?
@nickerso
Copy link
Contributor

"For the general[,] reader the informative specification is"

I assume this is really inserting a comma after the "reader" - otherwise I'm not understanding the suggestion :)

@nickerso
Copy link
Contributor

Make sure that our link to libCellML works. Right now, it points to https://libcellml.org/, which doesn't resolve.

I don't know what is happening with this. Last night it was fine, I just checked it and it failed to resolve a few times, but now is resolving fine. https://www.libcellml.org always resolved, so I've updated to that but am going to assume this was a glitch in readthedocs or the domain host which is all good now so will set it back to libcellml.org once someone else confirms that it works for them :) @hsorby

@agarny
Copy link
Contributor Author

agarny commented Apr 18, 2020

"For the general[,] reader the informative specification is"

I assume this is really inserting a comma after the "reader" - otherwise I'm not understanding the suggestion :)

Oops, indeed!

@nickerso
Copy link
Contributor

Remove the "CellML 2.0 Drafts" section? I don't see the point in making that page unnecessarily "complicated" by keeping things that people should never have a chance to refer.

I like having these there as it demonstrates that basically nothing has changed since those earlier drafts and hence we don't need to vote on each change as there is nothing significant. Also a huge amount of work went into those drafts and I don't want to lose them.

@agarny
Copy link
Contributor Author

agarny commented Apr 18, 2020

For me:

@agarny
Copy link
Contributor Author

agarny commented Apr 18, 2020

Remove the "CellML 2.0 Drafts" section? I don't see the point in making that page unnecessarily "complicated" by keeping things that people should never have a chance to refer.

I like having these there as it demonstrates that basically nothing has changed since those earlier drafts and hence we don't need to vote on each change as there is nothing significant. Also a huge amount of work went into those drafts and I don't want to lose them.

I like things to be "clean", but I can also understand your rationale. So, meh... ;)

@nickerso
Copy link
Contributor

For me:

ok, seems like it depends on browser and guess work and stuff. http://libcellml.org works and ends up at the right place - which in my browser looks like a secure libcellml.org but is actually https://www.libcellml.org. So when I type libcellml.org into my browser address bar it depends on whether it first tries https or http as to whether it resolves - incognito windows try http so they work, but my regular browser window tries https first :)

So we're all good - it is a deterministic issue with the domain name resolution that hopefully @hsorby can help me resolve. and I'll let the landing page as https://www.libcellml.org and say that this issue is resovled.

@agarny
Copy link
Contributor Author

agarny commented Apr 18, 2020

Ideally, I would like to see https://libcellml.org/ being used, but happy for https://www.libcellml.org/ to be used for now until we get the redirection properly done.

@kerimoyle
Copy link
Collaborator

Replace "The 'what has changed document' describes the changes between this version of CellML and the previous CellML 1.1." with "The release notes describe the changes between CellML 1.1 and this version of CellML." (and make "release notes" a link)?

Pretty lease can we not bury links through the text like this? They should be somewhere that is easy to find! Either in a short, name-only list directly above your paragraph of explanation, or the only things on the page.

CellML 2.0 Normative Blah Blah

Normative Specification document
Release notes
Any other important site
The normative blah blah description ... preferably no links here ... etc

CellML 2.0 Informative Blah Blah

Informative site
Libcellml tutorials
OpenCor tutorials
Description blah blah blah ...

etc.

Currently the hardest thing about reading any of these pages - the libcellml docs included - is that you have to read everything, and click every link - and there are legion - until you find what you're actually looking for.

@hsorby
Copy link
Contributor

hsorby commented Apr 18, 2020

For me:

I''m in the same boat as @agarny, I am going to play around with this and see what happens.

@hsorby
Copy link
Contributor

hsorby commented Apr 18, 2020

I think maybe we need to set a ANAME record with the DNS provider for libcellml.org for it to resolve. I can't remember if we did that? We did the CNAME? @nickerso did we set an ANAME when we set up the redirect?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants