Help angular module #2024

RFSH · 2020-10-28T22:52:54Z

In the latest task that @rastogi-bhavya was working on, we decided to add a help page to explain how users can draw using the new drawing tools. After discussing this, we decided to go with a more "future proof" solution that can be used for generating future help pages that we want to host directly in chaise page (without directing them outside of chaise.)

So I added a new "help" app which is just a template for rendering markdown values. For adding new help pages, we just need to provide a .md file and some extra attributes. With this approach, we don't need to worry about the HTML and AngularJS side of things and just focus on the content of our documents. This solution is very similar in nature to what is done for deriva docs.

I created this PR so @jrchudy and @hongsudt can see the approach and we can further discuss this solution. You can see how it works here:
https://dev.rebuildingakidney.org/~ashafaei/chaise/help/?page=viewer-annotation

We can later refactor our existing help pages (markdown tags and the switch-user one), to use this new app.

P.S.
@rastogi-bhavya I noticed that you were using HTML tags directly in your markdown, although that's acceptable in Github markdown parser, it's not acceptable by our internal parser. You should also stick with a relative path for images instead of an absolute path. That way your help pages work both in the app as well as Github. I modified one of your images, you can see how I did it and change the rest. With this new syntax, we're attaching specific classes to images that later we can modify. That being said, I think for now we should make sure this way of doing things is acceptable by all, then we can focus on the content of the help page.

Added highlight and text to images for better understanding

carlkesselman · 2020-10-28T23:23:46Z

nice. Where does the content actually live? I recall that in the past we created a markdown armrest type that would be properly rendered….. Carl

…

---------------------------------------------------------- Dr. Carl Kesselman Dean’s Professor, Epstein Department of Industrial and Systems Engineering Fellow, Information Sciences Institute Viterbi School of Engineering Professor, Preventive Medicine Keck School of Medicine University of Southern California 4676 Admiralty Way, Suite 1001, Marina del Rey, CA 90292-6695 Phone: +1 (310) 448-9338 Email: carl@isi.edu Web: http://www.isi.edu/~carl On Oct 28, 2020, 3:53 PM -0700, Aref Shafaei <notifications@github.com>, wrote: In the latest task that @rastogi-bhavya<https://github.com/rastogi-bhavya> was working on, we decided to add a wiki page to explain how users can draw using the new drawing tools. After discussing this, we decided to go with a more "future proof" solution that can be used for generating future wiki pages that we want to host directly in chaise page (without directing them outside of chaise.) So I added a new "wiki" app which is just a template for rendering markdown values. For adding new wiki pages, we just need to provide a .md file and some extra attributes. With this approach, we don't need to worry about the HTML and AngularJS side of things and just focus on the content of our documents. This solution is very similar in nature to what is done for deriva docs. I created this PR so @jrchudy<https://github.com/jrchudy> and @hongsudt<https://github.com/hongsudt> can see the approach and we can further discuss this solution. You can see how it works here: https://dev.rebuildingakidney.org/~ashafaei/chaise/wiki/?page=viewer-annotation We can later refactor our existing wiki pages (markdown tags<https://dev.rebuildingakidney.org/chaise/recordedit/mdHelp.html> and the switch-user one<https://dev.rebuildingakidney.org/chaise/lib/switchUserAccounts.html>), to use this new app.

________________________________ P.S. @rastogi-bhavya<https://github.com/rastogi-bhavya> I noticed that you were using HTML tags directly in your markdown, although that's acceptable in Github markdown parser, it's not acceptable by our internal parser. You should also stick with a relative path for images instead of an absolute path. That way your wiki pages work both in the app as well as Github. I modified one of your images, you can see how I did it and change the rest. With this new syntax, we're attaching specific classes to images that later we can modify. That being said, I think for now we should make sure this way of doing things is acceptable by all, then we can focus on the content of the wiki page.

RFSH · 2020-10-29T00:42:44Z

@carlkesselman The content is part of the chaise repository, under the same wiki folder. For example, this is the one page that we have right now:
https://github.com/informatics-isi-edu/chaise/blob/annotation-documentation/wiki/viewer-annotation.md

RFSH · 2020-10-29T00:45:15Z

I should also mention that I just wanted to show how this would work. We can change the style of the page and make it cleaner and easier to read (for example adding margin to both sides of the page so the content is in the middle and doesn't stretch to the whole screen.) For now, it's using the same default styles that we're using in chaise for the markdown column types.

carlkesselman · 2020-10-29T01:24:30Z

If the goal is to host directly in chaise, Is there any reason why we should not store this in hatred or use the ability to store directly in the catalog? Carl

…

---------------------------------------------------------- Dr. Carl Kesselman Dean’s Professor, Epstein Department of Industrial and Systems Engineering Fellow, Information Sciences Institute Viterbi School of Engineering Professor, Preventive Medicine Keck School of Medicine University of Southern California 4676 Admiralty Way, Suite 1001, Marina del Rey, CA 90292-6695 Phone: +1 (310) 448-9338 Email: carl@isi.edu Web: http://www.isi.edu/~carl On Oct 28, 2020, 5:43 PM -0700, Aref Shafaei <notifications@github.com>, wrote: @carlkesselman<https://github.com/carlkesselman> The content is part of the chaise repository, under the same wiki folder. For example, this is the one page that we have right now: https://github.com/informatics-isi-edu/chaise/blob/annotation-documentation/wiki/viewer-annotation.md — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#2024 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AA3OGXQ6UKJACPUXAXC7RVDSNC3BDANCNFSM4TC63ZIA>.

hongsudt · 2020-10-29T16:15:39Z

This is an embedded chaise help doc. Directly store it in the repo makes it simple to maintain and always available without dependence on external services. Other chaise documentations are stored in the repo under docs/ folder, same as other repos for maintaining documents (an agreement we established for documentations across software)The per deployment config files can be stored in hatrac or other places and configured during make install.On Oct 28, 2020 18:24, Carl Kesselman <notifications@github.com> wrote: If the goal is to host directly in chaise, Is there any reason why we should not store this in hatred or use the ability to store directly in the catalog? Carl

…

---------------------------------------------------------- Dr. Carl Kesselman Dean’s Professor, Epstein Department of Industrial and Systems Engineering Fellow, Information Sciences Institute Viterbi School of Engineering Professor, Preventive Medicine Keck School of Medicine University of Southern California 4676 Admiralty Way, Suite 1001, Marina del Rey, CA 90292-6695 Phone: +1 (310) 448-9338 Email: carl@isi.edu Web: http://www.isi.edu/~carl On Oct 28, 2020, 5:43 PM -0700, Aref Shafaei <notifications@github.com>, wrote: @carlkesselman<https://github.com/carlkesselman> The content is part of the chaise repository, under the same wiki folder. For example, this is the one page that we have right now: https://github.com/informatics-isi-edu/chaise/blob/annotation-documentation/wiki/viewer-annotation.md — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#2024 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AA3OGXQ6UKJACPUXAXC7RVDSNC3BDANCNFSM4TC63ZIA>. —You are receiving this because you were mentioned.Reply to this email directly, view it on GitHub, or unsubscribe.

carlkesselman · 2020-10-29T16:21:05Z

So then we are assuming that a per-deployment GitHub repo is a standard part of what we will have? Please keep in mind that our goal is to have AWS hosted deployments, and many of them and we need to ensure that as much configuration and maintenance can be pushed out to non-ISRD people as possible. Carl

…

---------------------------------------------------------- Dr. Carl Kesselman Dean’s Professor, Epstein Department of Industrial and Systems Engineering Fellow, Information Sciences Institute Viterbi School of Engineering Professor, Preventive Medicine Keck School of Medicine Ostrow School of Dentistry University of Southern California 4676 Admiralty Way, Suite 1001, Marina del Rey, CA 90292-6695 Phone: +1 (310) 448-9338 Email: carl@isi.edu<mailto:carl@isi.edu> Web: http://www.isi.edu/~carl On Oct 29, 2020, at 9:15 AM, Hongsuda <notifications@github.com<mailto:notifications@github.com>> wrote: This is an embedded chaise help doc. Directly store it in the repo makes it simple to maintain and always available without dependence on external services. Other chaise documentations are stored in the repo under docs/ folder, same as other repos for maintaining documents (an agreement we established for documentations across software)The per deployment config files can be stored in hatrac or other places and configured during make install.On Oct 28, 2020 18:24, Carl Kesselman <notifications@github.com<mailto:notifications@github.com>> wrote: If the goal is to host directly in chaise, Is there any reason why we should not store this in hatred or use the ability to store directly in the catalog? Carl

---------------------------------------------------------- Dr. Carl Kesselman Dean’s Professor, Epstein Department of Industrial and Systems Engineering Fellow, Information Sciences Institute Viterbi School of Engineering Professor, Preventive Medicine Keck School of Medicine University of Southern California 4676 Admiralty Way, Suite 1001, Marina del Rey, CA 90292-6695 Phone: +1 (310) 448-9338 Email: carl@isi.edu<mailto:carl@isi.edu> Web: http://www.isi.edu/~carl On Oct 28, 2020, 5:43 PM -0700, Aref Shafaei <notifications@github.com<mailto:notifications@github.com>>, wrote: @carlkesselman<https://github.com/carlkesselman> The content is part of the chaise repository, under the same wiki folder. For example, this is the one page that we have right now: https://github.com/informatics-isi-edu/chaise/blob/annotation-documentation/wiki/viewer-annotation.md — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#2024 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AA3OGXQ6UKJACPUXAXC7RVDSNC3BDANCNFSM4TC63ZIA>. —You are receiving this because you were mentioned.Reply to this email directly, view it on GitHub, or unsubscribe. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#2024 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AA3OGXUSU66D2WZ4Y73SKZ3SNGIL3ANCNFSM4TC63ZIA>.

karlcz · 2020-10-29T16:36:40Z

I think there's some confusion here, maybe triggered by the word "wiki"? As I understand it, this is just an internal function of chaise software and deployed like all the other static assets in chaise (for angular templates, icons, CSS, etc.) It is NOT a project-specific asset nor a collaborative tool. It is maintained by the Chaise developers like any other tightly-integrated bit of the HTML templates or the documentation that goes with a version of the software. It would be installed/updated automatically in the same step that installs updated Chaise code on the web server. The use of "wiki" was just an unfortunate way to refer to the syntax of the source content that the Chaise developers will maintain by hand... a markdown dialect rather than angular and HTML template code. It is not about content management at all.

RFSH · 2020-10-29T18:59:29Z

Our goal for this PR was to be able to have some sort of help pages for complex parts of Chaise directly in the Chaise UI. So when users navigate to those pages, they don’t get lost without a way back to Chaise (so we decided against directing them to deriva docs, or Github).

We already have two of such pages as I mentioned in the PR. We just never thought about doing it in a reproducible way. The wiki (which I realized is a bad term and I changed it to "help" instead) that I added is just like any other Chaise app/module that we have. All the content and template are part of the Chaise module and will be deployed with the same make install command alongside the rest of the Chaise. it’s just an easier way for us (Chaise developers) to just focus on writing documentation without worrying about the template each time.

I'm not trying to introduce a way to allow users of Chaise to modify the content of these documents.

…nnotation-documentation

- the scrollbar wasn't working and it was more confusing - we should use the proper left panel for toc instead.

This reverts commit e1fac69.

1. Added links 2. Added new screenshots 3. Added description about line and polygon.

RFSH · 2020-12-04T21:16:23Z

@jrchudy The PR is ready to be reviewed and merged. Please let me know if you have any concerns about this new app so we can discuss it. As we discussed earlier, we're not going to change any of the existing help pages right now, and this is only used for viewer app drawing help.

rastogi-bhavya and others added 9 commits October 16, 2020 15:12

Created view-annotation.md [ci skip]

aa68aeb

Adding screenshots for annotation documentation [ci skip]

08da81c

Adding login Image

b2f5d89

Update view-annotation.md

b7a58f1

Images Update

766866e

Added highlight and text to images for better understanding

Adding images to view-annotation.md [ci skip]

d440865

Inline image test [ci skip]

952981f

Add all the images inline [ci skip]

53a74dc

introduce wiki app

1157554

Fixed how images were added to the document [ci skip]

2d53157

Removing comments about line & polygon [ci skip]

28f8e52

RFSH changed the title ~~Wiki app~~ Help angular module Oct 29, 2020

RFSH self-assigned this Oct 29, 2020

crisaless and others added 7 commits October 30, 2020 17:17

copyediting

cf8a853

fixing anchor link

88e1b9d

fixing another anchor

cb4a67f

rename wiki app to help app + add toc to help pages

3e794f8

Merge branch 'master' of github.com:informatics-isi-edu/chaise into a…

8157e72

…nnotation-documentation

fix toc scroll

5e387a5

remove toc

650d871

- the scrollbar wasn't working and it was more confusing - we should use the proper left panel for toc instead.

RFSH marked this pull request as ready for review December 3, 2020 01:44

Screenshot image update [ci skip]

b050f00

rastogi-bhavya added 6 commits December 4, 2020 11:55

Adding EditButton icon [ci skip]

7a7bde2

Adding tool icon [ci skip]

e1fac69

Revert "Adding tool icon [ci skip]"

ad72110

This reverts commit e1fac69.

Shape Icon image [ci skip]

019db16

Made suggested changes to the doc [ci skip]

ce860bb

1. Added links 2. Added new screenshots 3. Added description about line and polygon.

Adding space to make the content uniform

05d54f0

RFSH requested a review from jrchudy December 4, 2020 21:14

jrchudy approved these changes Dec 4, 2020

View reviewed changes

add a message to osd to open help page + remove unused code

b13fe8a

RFSH merged commit 767a371 into master Dec 5, 2020

RFSH deleted the annotation-documentation branch December 5, 2020 02:10

RFSH mentioned this pull request Dec 7, 2020

Add more drawing tools informatics-isi-edu/openseadragon-viewer#52

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Help angular module #2024

Help angular module #2024

RFSH commented Oct 28, 2020 •

edited

Loading

carlkesselman commented Oct 28, 2020 via email

RFSH commented Oct 29, 2020

RFSH commented Oct 29, 2020

carlkesselman commented Oct 29, 2020 via email

hongsudt commented Oct 29, 2020 via email

carlkesselman commented Oct 29, 2020 via email

karlcz commented Oct 29, 2020 via email

RFSH commented Oct 29, 2020

RFSH commented Dec 4, 2020

Help angular module #2024

Help angular module #2024

Conversation

RFSH commented Oct 28, 2020 • edited Loading

carlkesselman commented Oct 28, 2020 via email

RFSH commented Oct 29, 2020

RFSH commented Oct 29, 2020

carlkesselman commented Oct 29, 2020 via email

hongsudt commented Oct 29, 2020 via email

carlkesselman commented Oct 29, 2020 via email

karlcz commented Oct 29, 2020 via email

RFSH commented Oct 29, 2020

RFSH commented Dec 4, 2020

RFSH commented Oct 28, 2020 •

edited

Loading