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

Move lots of general docs to webpage #93

Merged
merged 14 commits into from
Apr 7, 2019
Merged

Conversation

apeltzer
Copy link
Member

@apeltzer apeltzer commented Apr 7, 2019

As @ewels was so nice to add the super easy possibility to shift over some of the markdown basic documentation from tools, I took the liberty to start doing this now 👍 I might add some more docs there, and we need to remove (once this is merged) the rest of it in the tools repository to have only one location in the future.

Once the syncing kicks in after the next tools release, we can simply link to the main webpage / documentation there and should be up2date 🎉

@apeltzer apeltzer requested a review from a team April 7, 2019 15:40
@apeltzer
Copy link
Member Author

apeltzer commented Apr 7, 2019

x-ref: nf-core/tools#298, which removes these docs from nf-core/tools

@apeltzer
Copy link
Member Author

apeltzer commented Apr 7, 2019

Updating the Troubleshooting section is also something that I'd like to do soonish, but that is something for the hackathon next week 👍

#94

Copy link
Member

@ewels ewels left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good! A few comments about content, though I realise that this is mostly copying and pasting, so no worries if you'd rather merge now and refine later.

I do think that there is quite a lot of duplication in these docs, and that they're not particularly well organised. I think that we could do with a general overhaul of it all pretty soon...

markdown/usage/adding_own_config.md Outdated Show resolved Hide resolved
markdown/usage/adding_own_config.md Outdated Show resolved Hide resolved
markdown/usage/adding_own_config.md Outdated Show resolved Hide resolved
markdown/usage/adding_own_config.md Outdated Show resolved Hide resolved
markdown/usage/adding_own_config.md Outdated Show resolved Hide resolved
markdown/usage/adding_own_config.md Outdated Show resolved Hide resolved
markdown/usage/local_installation.md Show resolved Hide resolved
markdown/usage/local_installation.md Outdated Show resolved Hide resolved
ewels and others added 9 commits April 7, 2019 23:41
Co-Authored-By: apeltzer <apeltzer@users.noreply.github.com>
Co-Authored-By: apeltzer <apeltzer@users.noreply.github.com>
Co-Authored-By: apeltzer <apeltzer@users.noreply.github.com>
Co-Authored-By: apeltzer <apeltzer@users.noreply.github.com>
Co-Authored-By: apeltzer <apeltzer@users.noreply.github.com>
@apeltzer
Copy link
Member Author

apeltzer commented Apr 7, 2019

Yes, I also think we need to merge certain parts of this and also make these updates everywhere across all pipelines available in linking to this over here 👍
Will merge now that I changed all your requests + added some more disclaimers, can later polish this even further (as its also now independent of nf-core/tools template, once that PR is merged too!)

@apeltzer apeltzer merged commit 9e1bd2b into nf-core:master Apr 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants