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

Issue 79 + 82 #83

Closed
wants to merge 6 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -2,3 +2,34 @@

usernames.txt
user_blacklist.txt

*.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk

_site/
.sass-cache/
.jekyll-metadata
38 changes: 22 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
---
title: Biopython.org website README
title: Biopython.org - README
layout: default
---

The git repository at <https://github.com/biopython/biopython.github.io/>
produces the Biopython website at <https://biopython.org>
using GitHub Pages (rendered using Jekyll, see
<https://help.github.com/articles/using-jekyll-with-pages/> for details).
# README

Almost all of the content is under the URL prefix ``/wiki/`` because
this was based on an automated conversion of the old MediaWiki website,
using <https://github.com/peterjc/mediawiki_to_git_md> to turn all
the changes in the MediaWiki XML export file into into markdown (using
pandoc) as a git repository.
### Few things to note:
- The git repository at <https://github.com/biopython/biopython.github.io/>
produces the Biopython website at <https://biopython.org> using GitHub Pages (rendered using Jekyll, see <https://help.github.com/articles/using-jekyll-with-pages/> for details).

The old MediaWiki usernames were manually mapped to GitHub accounts.
About 20 accounts on the wiki (mostly single contributions) could not
be identified, but the old username is still logged in the git commits.
- Almost all of the content is under the URL prefix ``/wiki/`` because this was based on an automated conversion of the old MediaWiki website, using <https://github.com/peterjc/mediawiki_to_git_md> to turn all the changes in the MediaWiki XML export file into into markdown (using pandoc) as a git repository.

Note the website content under ``/DIST/`` is hosted in a separate
GitHub Pages project repository <https://github.com/biopython/DIST>
covering the Biopython releases and assorted documentation files.
- The old MediaWiki usernames were manually mapped to GitHub accounts. About 20 accounts on the wiki (mostly single contributions) could not be identified, but the old username is still logged in the git commits.

- Note the website content under ``/DIST/`` is hosted in a separate GitHub Pages project repository <https://github.com/biopython/DIST> covering the Biopython releases and assorted documentation files.

### To contribute to this site:
- If you haven't already, begin by creating an account for yourself [here](http://lists.open-bio.org/mailman/listinfo/biopython-dev/) at the Biopython Developers List.
- Introduce yourself to the Biopython community by sending an email to <[email protected]>.
- If you haven't already, create a [Github](https://github.com/) account [here](https://github.com/join?source=header-home).
- Then fork a copy of <https://github.com/biopython/biopython.github.io> repository which holds the source for this site.
- The above step should create a copy of the repository under your Github user account.
- Clone this copy of the repository to your local machine.
- Follow the instructions (specific to your OS) to setup a local *Jekyll 3* environment (see <https://jekyllrb.com/docs/installation/>) so you can test your changes locally.
- Then create a descriptive local branch and do your magic - fix a bug/outstanding issue and/or improve/implement a feature.
- Test your changes locally and push to your local repository.
- Finally submit a pull request!
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@ layout: default
---

We recently [migrated from MediaWiki to GitHub pages](https://github.com/peterjc/mediawiki_to_git_md),
see our [README](https://biopython.github.io/README.html) file for details.
see our [README](/README.html) file for details.

The new site is mostly working, but there are a number of
[known issues](https://github.com/biopython/biopython.github.io/issues).