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

Update documentation #6

Closed
bradfordcondon opened this issue Mar 1, 2018 · 7 comments
Closed

Update documentation #6

bradfordcondon opened this issue Mar 1, 2018 · 7 comments
Assignees

Comments

@bradfordcondon
Copy link
Contributor

The documentation here needs to be good enough to publish.

As you load in the full dev dataset, it would be awesome if you could contribute guides to doing it.

Many cases the guides are already written but they are on the staton wiki. for example:

https://github.com/mestato/statonlabprivate/wiki/Loading-a-Transcriptome-Geome-Tripal-3

In those cases, you can create a branch for that guide, add it, and make a PR. Screenshots would be great.

@jwest60
Copy link
Contributor

jwest60 commented Mar 8, 2018

@bradfordcondon just finished the last of the edits. i moved the expression documentation from the biomaterials branch to the new expression branch and updated the fasta documentation and added screenshots for everything.

one of the things worth noting is that the only way i could get the screenshots to display the way they are is to hard link them, so that might be an issue moving forward?

@bradfordcondon
Copy link
Contributor Author

great Joe!

the only way i could get the screenshots to display

I'll have al ook... what I do is put them in like /docs/img/... and hten you can use relative path to link them...

@jwest60
Copy link
Contributor

jwest60 commented Mar 8, 2018

that works, but then the image will only display once the user clicks the link instead of showing it automatically, which is fine if that's the way you want to do it

@bradfordcondon
Copy link
Contributor Author

bradfordcondon commented Mar 8, 2018

please look at https://github.com/tripal/tripal_analysis_expression/blob/master/README.md

files are linked as, for example

![The Biosample property configuration tool](example_files/doc_images/biosample_prop_checker.png)
and display

@jwest60
Copy link
Contributor

jwest60 commented Mar 8, 2018

Yeah, I just realized I used the wrong relative path the first time, I'm going to go back through and change all the links first thing tomorrow, shouldn't take too long.

@jwest60
Copy link
Contributor

jwest60 commented Mar 8, 2018

actually i just went ahead and did it now so all the links should now be relative paths

@bradfordcondon
Copy link
Contributor Author

these have all been merged in. Need to create a documentation index.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants