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

DOC: Flesh out front page example. #1237

Closed
wants to merge 1 commit into from

Conversation

@arokem
Copy link
Member

commented May 8, 2017

No description provided.

@arokem arokem referenced this pull request May 8, 2017
1 of 4 tasks complete
@ghoshbishakh

This comment has been minimized.

Copy link
Member

commented May 8, 2017

well we could have just changed it from the cms as it is not a part of the documentation. 😅

I will make a copy of it in the site.

@arokem

This comment has been minimized.

Copy link
Member Author

commented May 8, 2017

@ghoshbishakh

This comment has been minimized.

Copy link
Member

commented May 8, 2017

Sorry we had no intension of putting the docs into a database. It stays in github. I will be updating the docs in the new site soon if i get a machine to build it.

@arokem

This comment has been minimized.

Copy link
Member Author

commented May 8, 2017

@Garyfallidis

This comment has been minimized.

Copy link
Member

commented May 8, 2017

@ghoshbishakh

This comment has been minimized.

Copy link
Member

commented May 8, 2017

Garyfallidis had this idea that some content needs to be changed frequently like news, publications, announcements, some images in the front page, videos and some things need to be automated like generate a gallery of tutorials etc.

So the cms is only for holding the frequently changed content and it will be keeping track of different versions of documentations that come from github.

@arokem

This comment has been minimized.

Copy link
Member Author

commented May 8, 2017

@arokem

This comment has been minimized.

Copy link
Member Author

commented May 8, 2017

@ghoshbishakh

This comment has been minimized.

Copy link
Member

commented May 8, 2017

How would a user propose changes to these web-pages? For example, if they find a typo?

For the manual, that is the doc, a PR in dipy repo is necessary to fix a typo.

For front page changes, video gallery changes, publication changes, and any typo in the cms pages we can login to the cms and those who have merge permission in dipy can change the content.
And for reporting purpose I think an issue is necessary. I get you point on that.

I wish I had a build system like travis ci that could maintain the docs with each commit building the docs take about 32GB of memory. For now I dont see any way of making the doc updation process seamless.

@codecov-io

This comment has been minimized.

Copy link

commented May 8, 2017

Codecov Report

Merging #1237 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master   #1237   +/-   ##
======================================
  Coverage    86.1%   86.1%           
======================================
  Files         223     223           
  Lines       27895   27895           
  Branches     2829    2829           
======================================
  Hits        24018   24018           
  Misses       3180    3180           
  Partials      697     697

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b7aa619...c58368f. Read the comment docs.

@coveralls

This comment has been minimized.

Copy link

commented May 8, 2017

Coverage Status

Coverage remained the same at 88.591% when pulling c58368f on arokem:front-page-example into b7aa619 on nipy:master.

@Garyfallidis

This comment has been minimized.

Copy link
Member

commented May 9, 2017

Here is also an answer about why dynamic and not static. We are often thinking only in terms of developers and not users. A user could very simply post some news without being a developer but still nicely advertise the project.

In our previous experience we saw that DIPY developers (including ourselves) very rarely change and update the website especially with news. This is an effort to move away from this issue.

A dynamic website allows us to be more flexible in what we can do with the page and how we can add sections. For example, we can keep track of our own publications in one of the sections, or records some stats for grant applications etc.

Nonetheless, I think we should try it and see how it goes for a couple of years and then revisit. But we really need to do something with our website. It definitely needed a remake.

I hope this information clarifies some of the discussion.

@Garyfallidis

This comment has been minimized.

Copy link
Member

commented May 9, 2017

Also, let's please refrain from phrases like "big mistake" without any detailed argumentation. Working on improving our website is not a bad thing even if the dynamic website is not the correct direction we are learning a lot. Time will tell. Also, we have been working on the new website for some time so I do not understand why the urgency and emotions for changes right now.

Finally, @ghoshbishakh had noticed high memory usage in only some of the tutorials. I believe some of those are yours @arokem so I would suggest to look into reducing the memory consumption of those tutorials. I believe we wrote issues about those some time ago I do not remember the actual issue numbers.

@arokem

This comment has been minimized.

Copy link
Member Author

commented May 9, 2017

@arokem

This comment has been minimized.

Copy link
Member Author

commented Mar 15, 2019

This is not going to be in the new website. Closing

@arokem arokem closed this Mar 15, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.