pombase / curation

PomBase curation
7 stars 0 forks source link

FAQ for Canto #3621

Open ValWood opened 8 years ago

ValWood commented 8 years ago

We should start to collect questions, and draft answers for M. to polish

Will assign to Midori, but as we add the questions here we should attempt to write an answer to edit. Will start later....

Antonialock commented 8 years ago
kimrutherford commented 8 years ago

The easiest plan for me is to add an FAQ to Canto's built in documentation. I've made an example here: https://github.com/pombase/canto/blob/master/root/docs/md/faq.md

That example is visible here: https://curation.pombase.org/pombe/docs/faq

but there is no link to it.

You can edit in place with the edit button (looks like a pencil). The syntax is Markdown like GitHub uses. Here is the full syntax: https://fletcher.github.io/MultiMarkdown-5/syntax.html

Here is GitHub's help file on Markdown: https://guides.github.com/features/mastering-markdown/

Canto needs to be re-released if you edit the docs. That's two step process.

  1. in the canto directory (from "git clone ...") do: ./etc/tag_release.pl
  2. on oliver0 run this from any directory: sudo /var/pomcur/scripts/pull_and_restart pombe

I've only ever done that logged in as me so it may not work first time. I'm happy to fix any problems though.

ValWood commented 8 years ago
ValWood commented 8 years ago

Could look through the helpdesk tickets for old questions and draft answers?

ValWood commented 7 years ago
ValWood commented 2 years ago

This seems like a good task for the new starter.

ValWood commented 9 months ago

We have the FAQ now, so new person can check these questions are included

ValWood commented 9 months ago

This issue should be in the FAQ https://github.com/pombase/canto/issues/2616