Skip to content

Commit

Permalink
Update organization files
Browse files Browse the repository at this point in the history
All files are adapted versions of those found in the blog already.
  • Loading branch information
HeroicKatora committed Apr 22, 2019
1 parent e13cfa3 commit 8a447fc
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.bundle
Gemfile.lock
_site
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
The main site of `image-rs` at <www.image-rs.org>.

## Contributing

Any member of the organization is welcome to contribute to the site, not only
collaborators. The main branch that is served over `www.image-rs.org` should
only be changed through PRs with at least one review, regardless of the author.
Major changes to the structure or look should gather some feedback over a week
but at least three days (so that one is a work day).

Most pressing issues:

* Design the pages instead of relying on a rather unstructured default look.
* Establish a system for tags and categories
* Evaluate how to present the individual projects under the organization. Each
projects could have one dedicated maintainer on its project page.

## Serving locally

For basic usage, follow [the official Github guide][GHGuide]. If you are not
comfortable giving `sudo` to the `bundler` commands just for this project (i.e.
this is not your main project or you created a project related account to
confine access, ...) like me then you can also do:

1. Create some local directory used to hold the installed gems. I use
`GEM_HOME=~/.local/lib/gems` to mirror the root tree that would otherwise be used.
2. > `bundle install --path $GEM_HOME`
3. Invoke jekyll through `bundle` as well
> `bundle exec jekyll serve`

[GHGuide]: https://help.github.com/en/articles/setting-up-your-github-pages-site-locally-with-jekyll

0 comments on commit 8a447fc

Please sign in to comment.