search

wikipathways / wikipathways-development

Roadmap planning, developer documentation, contribution guidelines
2 stars 0 forks source link

Help/Documentation #19

Closed khanspers closed 2 years ago

khanspers commented 3 years ago

We should identify which part of the current content are useful and should be either 1) transferred to github site in some form 2) converted to reveal tutorials to be linked to from github site 3) already covered by other content (i.e. PathVisio etc).

The overall idea is to simplify and streamline the content, and to NOT create too many pages at the github site.

khanspers commented 3 years ago

Planning doc: https://docs.google.com/spreadsheets/d/1Ko9eLliQ5wbokioJyXTVfC9VtnPmoBYtyF38sX9ThDg/edit#gid=1551451845

khanspers commented 3 years ago

Update: We will skip reveal and instead use Google Slides. One idea is to create a Google Slides deck for each of the three main topics in the current content (roughly): Biologists and Chemists, Pathway Authors, Developers.

khanspers commented 2 years ago

Proposed plan: The front page Learn section has 4 links with topics that can each lead to dedicated content:

How to Contribute: Either a dedicated page OR linkout to Google slide deck How to Curate: link to Academy (done) How to Use: linkout to Google slide deck How to Develop: linkout to Google slide deck

I will start drafts of these and will add links here as they become available. Open to any feedback on the overall plan or details.

khanspers commented 2 years ago

Front page has been updated:

To-Do: Update the list on Analyze page to include some sort of bullet

khanspers commented 2 years ago

FAQ has been added here: https://github.com/wikipathways/wikipathways-help/discussions

khanspers commented 2 years ago

What we have so far: How to contribute: https://new.wikipathways.org/contribute.html (linked to from Create on front page) Analyze: https://new.wikipathways.org/analyze.html (linked to from Analyze on front page) FAQ: https://github.com/wikipathways/wikipathways-help/discussions (not linked to right now)

What we still need: How to Publish Intro tutorial

Unclear: Do we still need this page: https://new.wikipathways.org/help.html If yes, then it should be redesigned with the same terminology as elsewhere (Create, Curate, Analyze etc). If no, then update links to Help to something else.

Chris-Evelo commented 2 years ago

I would think: "yes we need that". While it is good to link to a more specific help page for every activity. People might still want o study the whole thing starting with "help". For that same reason, it is also to link to a page describing tutorials from that help page.

khanspers commented 2 years ago

I updated the Help page. If there are specific things that should be covered on this page, please list them in this issue. Keep in mind that we are trying to link out to existing content or other pages as mush as possible, to keep the main Help page short and concise.

AlexanderPico commented 2 years ago

Agreed. How about these sections (each can be brief outlines, like the current ones, and link out for details):

AlexanderPico commented 2 years ago

Pro-tip. If you wrap each section in a <div id="analyze">...</div> then we can link with anchors like https://new.wikipathways.org/help.html#analyze

khanspers commented 2 years ago

The FAQ is done for now: https://github.com/wikipathways/wikipathways-help/discussions To-Do for the remaining items:

khanspers commented 2 years ago

Here's the current status and timeline. Also, it would be great to have others review these pages for content, clarity etc.

  1. Help page (https://new.wikipathways.org/help.html)

  1. Contribute page https://new.wikipathways.org/contribute.html: Done.

  2. Other static pages related to Help:

khanspers commented 2 years ago

Update: Navigate and Publish have been updated. The only thing missing from the original list is NDEx-minted DOIs for specific versions which I don't know how to do.

AlexanderPico commented 2 years ago

Update: Navigate and Publish have been updated. The only thing missing from the original list is NDEx-minted DOIs for specific versions which I don't know how to do.

Currently, the only way is to email Dexter. But they are planning to add a button at some point.

khanspers commented 2 years ago

Should I add a sentence or two describing it, with Dexter’s contact?

Kristina

On Fri, Jul 15, 2022 at 3:12 PM Alexander Pico @.***> wrote:

Update: Navigate and Publish have been updated. The only thing missing from the original list is NDEx-minted DOIs for specific versions which I don't know how to do.

Currently, the only way is to email Dexter. But they are planning to add a button at some point.

— Reply to this email directly, view it on GitHub https://github.com/wikipathways/wikipathways-development/issues/19#issuecomment-1185988396, or unsubscribe https://github.com/notifications/unsubscribe-auth/AALADFOYFNR2VCBVP26YQX3VUHO4FANCNFSM5GYYNQ7Q . You are receiving this because you were assigned.Message ID: @.***>

AlexanderPico commented 2 years ago

Nope. Just ignore for now.