Skip to content

Commit 043127e

Browse files
authored
DOC: Add a link to the Nipy Discourse instance in contributing materials (#67)
* DOC: Add a link to the Nipy Discourse instance in contributing materials Add a link to the Nipy Discourse instance as a venue where contributions should be discussed. * ENH: Add `--trace` flag to the CircleCI jekyll build command Add `--trace` flag to the CircleCI jekyll build command to allow revealing further information when building.
1 parent 033e65e commit 043127e

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

Diff for: .circleci/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737
echo "Building Snakey thoughts!"
3838
chmod u+x circle_urls.sh
3939
bash circle_urls.sh
40-
bundle exec jekyll build
40+
bundle exec jekyll build --trace
4141
- persist_to_workspace:
4242
root: ./
4343
paths:

Diff for: _data/contribute.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
questions:
66
- tag: "add-a-package"
77
question: "How do I add a package?"
8-
answer: "<h3>Infrastructure and workflow</h3><p>Let's first look at the infrastructure and workflow of the site</p><p><ul class='list-group'><li class='list-group-item'><strong>Github</strong>:The site is a repo under the nipy organization on<a href='https://github.com/nipy/nipy.github.com' target='_blank'> github</a>.This means that contribution to it goes by way of forking the repo and doing a pull request (PR).</li><li class='list-group-item'><strong>Github pages</strong>: We also use hosting on github pages, which only means that the site lives on a branch called gh-pages that gets rendered at nipy.github.io.</li><li class='list-group-item'><strong>CI</strong>: We use continuous integration to preview all PRs by way of viewing <a href='https://circle-artifacts.com/gh/vsoch/nipy-jekyll/63/artifacts/0/home/ubuntu/nipy-jekyll/_site/index.html' target='_blank'>artifacts</a>.</li></ul></p><h3>Your Workflow</h3><p>You should do the following:</p><ul><li>Fork the nipy jekyll repo</li><li>Make your changes</li><li>Submit a PR</li><li>We will review the PR, and push to master and ghpages branches.</li></ul></p><h3>Details</h3><ol><li>Add your package info to the data file, in the same format. This will have it rendered automatically in the navigation, and added to the animated brain on all pages.</li><li>Add a base page for your package in the base directory of the site repo. It should be named [packagetag].html where [packagetag] corresponds with the tag variable in the data file. We have a page template for packages, and the easiest thing to do is copy another package's page to start.</li><li>Static site content can be put in the js,css,img folders in the base directory. Any static content can be linked to like '{{ '/img/myimage.png' | prepend: site.baseurl }}'. Keep it organized.</li><li>To contribute an svg image, put it in the '_includes/svg' folder and include like {% include svg/mysvg.svg %}</li><li>Subpages should be contributed as posts to <a href='http://neuroimaging.tumblr.com'>blog content</a>.</li></ol><p>"
8+
answer: "<h3>Venue</h3><p>Contributors are welcome to propose and discuss their ideas to develop Python packages for neuroimaging in the <a href='https://nipy.discourse.group' target='_blank'>Nipy Discourse instance</a></p><h3>Infrastructure and workflow</h3><p>Let's first look at the infrastructure and workflow of the site</p><p><ul class='list-group'><li class='list-group-item'><strong>Github</strong>:The site is a repo under the nipy organization on<a href='https://github.com/nipy/nipy.github.com' target='_blank'> github</a>.This means that contribution to it goes by way of forking the repo and doing a pull request (PR).</li><li class='list-group-item'><strong>Github pages</strong>: We also use hosting on github pages, which only means that the site lives on a branch called gh-pages that gets rendered at nipy.github.io.</li><li class='list-group-item'><strong>CI</strong>: We use continuous integration to preview all PRs by way of viewing <a href='https://circle-artifacts.com/gh/vsoch/nipy-jekyll/63/artifacts/0/home/ubuntu/nipy-jekyll/_site/index.html' target='_blank'>artifacts</a>.</li></ul></p><h3>Your Workflow</h3><p>You should do the following:</p><ul><li>Fork the nipy jekyll repo</li><li>Make your changes</li><li>Submit a PR</li><li>We will review the PR, and push to master and ghpages branches.</li></ul></p><h3>Details</h3><ol><li>Add your package info to the data file, in the same format. This will have it rendered automatically in the navigation, and added to the animated brain on all pages.</li><li>Add a base page for your package in the base directory of the site repo. It should be named [packagetag].html where [packagetag] corresponds with the tag variable in the data file. We have a page template for packages, and the easiest thing to do is copy another package's page to start.</li><li>Static site content can be put in the js,css,img folders in the base directory. Any static content can be linked to like '{{ '/img/myimage.png' | prepend: site.baseurl }}'. Keep it organized.</li><li>To contribute an svg image, put it in the '_includes/svg' folder and include like {% include svg/mysvg.svg %}</li><li>Subpages should be contributed as posts to <a href='http://neuroimaging.tumblr.com'>blog content</a>.</li></ol><p>"
99
- tag: "write-a-post"
1010
question: "How do I write a post?"
1111
answer: "<h3>Quick and Easy</h3><p>The fastest way to contribute is to <a href='http://neuroimaging.tumblr.com/submit'> submit </a> an idea, link, or video right away, or <a href='http://neuroimaging.tumblr.com/ask'>ask us a question</a>. Your submission will be reviewed and immediately available on the site and for social media integration.</p><h3>Contribute Regularly</h3><p>If you like writing tutorials, or regularly write about your research, we encourage you to <a href='https://www.tumblr.com/docs/en/posting' target='_blank'> read more about posting</a> and <a href='mailto:[email protected]'>contact us</a> with your email or tumblr username, and you will be added as a contributor to the blog. As an official contributor you can write posts in several formats, receive notifications, integrate apps, and contribute via email. Contributors are subject to the same standards of conduct as non-affiliated posters.</p><h3>Package Specific</h3><p>To contribute content, or a 'blogroll' for your package, we encourage you to become a tumblr contributor, tag your posts with your package, and <a href='https://www.tumblr.com/docs/en/using_tags#specific' target='_blank'>link to the tagged posts</a> from your package page.</p>"

0 commit comments

Comments
 (0)