galaxyproject / galaxyproject/idc

Data Documentation -- discussion

Open
#84 0 comments 0 reactions 0 assignees View on GitHub
discussion
Dominant language
Shell
Stars
10
Forks
8
PR merge metrics
No merged PRs in 30d

Description

We need a unified strategy for data documentation.

Do we have to wait for the full IDC? What can we do near term?

Technical users.

1. Describe the data hosted on CVMFS. Summary of datacache and how to review it
2. Some automatic by detection but also reserved areas for administrative overrides -- manual and "also detect this /myserver/data/path".
3. Auto-populated with logic (curation for logic, not content)
4. More cross links to/from tutorials.

Scientific users: interpret the above, then make it human readable for non-technical people, and include actionable info to supplement what a tutorial or Help section abstracts. This server + this tool + this goal = decision matrix.

1. Breadth of data for context ... and a notation system for what is available on **this** server.
2. Layer in all the questions about reference data -- what the server has, what needs to be loaded, link to tutorials for the How-to (FAQs bundled into new "Olympics" types of tutorials).
3. **Importantly** should include tool/parameter combinations you'll need to access a specific index.
* Busco is an example -- https://help.galaxyproject.org/search?q=busco.
4. Bookmarked guide! A tool form can link back into the guide via tool_id?

**I'll work on this with whoever is interested!**

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the requirements and open questions in issue #84, especially the CVMFS data description, reference-data guidance, tool/parameter combinations, and tutorial cross-links. No files, tests, or entry points are identified; done would require an agreed documentation strategy and a defined near-term scope.

Written by the indexing model from the issue text.

Assessment

Domain
data, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.