Skip to content
Snippets Groups Projects
Commit 0808684b authored by Thomas Wood's avatar Thomas Wood
Browse files

Use publications repository for publications.

parent 95be43e6
No related branches found
No related tags found
No related merge requests found
before_script:
stages:
- update
- test
- deploy
update_publications:
stage: update
script:
- git checkout -B ${CI_BUILD_REF_NAME}
- git submodule update --init --remote
- git add publications
- git commit -m "[AUTO] Updating publications submodule" --author="Resource Reasoning Group Backup Bot <rr-gitlab-bot@example.com>" || exit 0
- git remote rm rw || exit 0
- git remote add rw git@gitlab.doc.ic.ac.uk:${CI_PROJECT_PATH}.git
- eval `ssh-agent`
- echo "$PUSH_KEY" | ssh-add -
- git push rw ${CI_BUILD_REF_NAME}
- ssh-agent -k
only:
- triggers
.before_script: &before_script
- bundle install --without=development
- bundle exec rake init
test:
stage: test
before_script: *before_script
script:
- bundle exec rake test
# Not a test stage to prevent race conditions with gem installations.
deadlinks:
stage: deploy
script:
- bundle exec rake testlinks
allow_failure: true
except:
- triggers
deploy:
stage: deploy
environment: production
before_script: *before_script
script:
- bundle exec rake deploy
tags:
- doc
only:
- master
except:
- triggers
# Not a test stage to prevent race conditions with gem installations.
deadlinks:
stage: deploy
script:
- bundle exec rake testlinks
allow_failure: true
except:
- triggers
[submodule "publications"]
path = publications
url = https://gitlab.doc.ic.ac.uk/resource-reasoning/publications.git
branch = master
......@@ -15,5 +15,4 @@ group :test do
end
group :development do
gem 'pry'
end
......@@ -6,7 +6,7 @@ GEM
i18n (~> 0.7)
minitest (~> 5.1)
tzinfo (~> 1.1)
addressable (2.5.0)
addressable (2.5.1)
public_suffix (~> 2.0, >= 2.0.2)
bibtex-ruby (4.4.3)
latex-decode (~> 0.0)
......@@ -15,7 +15,6 @@ GEM
citeproc-ruby (1.1.6)
citeproc (>= 1.0.4, < 2.0)
csl (~> 1.4)
coderay (1.1.1)
colorator (1.1.0)
colored (1.2)
concurrent-ruby (1.0.5)
......@@ -69,7 +68,6 @@ GEM
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
mercenary (0.3.6)
method_source (0.8.2)
mini_portile2 (2.1.0)
minitest (5.10.1)
namae (0.11.3)
......@@ -78,10 +76,6 @@ GEM
parallel (1.11.1)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
pry (0.10.4)
coderay (~> 1.1.0)
method_source (~> 0.8.1)
slop (~> 3.4)
public_suffix (2.0.5)
rake (12.0.0)
rb-fsevent (0.9.8)
......@@ -90,11 +84,10 @@ GEM
rouge (1.11.1)
safe_yaml (1.0.4)
sass (3.4.23)
slop (3.6.0)
thread_safe (0.3.6)
typhoeus (0.8.0)
ethon (>= 0.8.0)
tzinfo (1.2.2)
tzinfo (1.2.3)
thread_safe (~> 0.1)
unicode (0.4.4.2)
yell (2.0.7)
......@@ -108,7 +101,6 @@ DEPENDENCIES
jekyll-redirect-from
jekyll-scholar (~> 5.9.1)
jekyll-sitemap
pry
rake
BUNDLED WITH
......
......@@ -13,34 +13,10 @@ you should have access to edit it if a member of the resource-reasoning group.
[![Build Status](https://gitlab.doc.ic.ac.uk/resource-reasoning/psvg.doc.ic.ac.uk/badges/master/build.svg)](https://gitlab.doc.ic.ac.uk/resource-reasoning/psvg.doc.ic.ac.uk/commits/master)
[![Dependency Status](https://gemnasium.com/bd81b2aa11ff43417700f75dbd194221.svg)](https://gemnasium.com/6ba7afbbfda9adcba06f007cc565a29a)
Managing Content
----------------
## Managing Content
### Publications
#### File Downloads
Files associated with publications should be placed in the `publications` directory.
The filename prefix *must* be the key used for the corresponding entry in the BibTeX file.
The filename suffix (extension) determines how the file appears in the page listing. Unknown filetypes are permitted,
but will be printed in a bland, not-very-descriptive way.
Known filename suffixes are defined in `_data/publication_file_types.yml` and are summarised in the table below:
<style>
td, th { padding: 3px; }
td i { text-align: center; }
</style>
<table>
<tr><th>Extension</th><th>Icon</th><th>Text</th><th>File contents used as link?</th></tr>
{% for type in site.data.publication_file_types %}
<tr>
<td><code class="highligher-rouge">.{{ type.ext }}</code></td>
<td style="text-align: center"><i class="fa {{ type.icon }}"></i></td>
<td>{{ type.text }}</td>
<td style="text-align: center"><i class="fa fa-{% if type.include %}check{% else %}times{% endif %}"></i></td>
</tr>
{% endfor %}
</table>
Please see [the dedicated publications repository](https://gitlab.doc.ic.ac.uk/resource-reasoning/publications) for
instructions on how to add new publications to the website.
Technical Detail
----------------
......@@ -96,6 +72,7 @@ If you wish to test the site locally, ensure you have ruby installed, and then i
```
gem install bundler
bundle install
bundle exec rake init
```
And to start a local webserver that remakes files whenever changed:
......
......@@ -2,6 +2,11 @@ require 'html-proofer'
task :default => :build
desc "Initialise/update git submodules"
task :init do
sh "git submodule update --init --remote"
end
desc "Build the site"
task :build do
sh "bundle exec jekyll build"
......@@ -10,7 +15,7 @@ end
htmlproofer_config = {
:disable_external => true,
:check_html => true,
:parallel => { :in_processes => 4 }
:parallel => { :in_processes => 1 }
}
desc "Build the site and test output for dead links, invalid html etc."
......
# This file defines how particular supplementary file types should be rendered
# on a publication page.
# Fields:
# ext: the file extension (longest part)
# icon: fontawesome identifier names (see http://fontawesome.io/icons/)
# text: descriptive text for type of file
# include: set to true to use the *contents* of the file as the URL to link to
- ext: pdf
icon: fa-file-text-o
text: "Authors' Preprint"
- ext: techreport.pdf
icon: fa-file-text-o
text: Technical Report
- ext: zip
icon: fa-file-archive-o
text: "File Archive (.zip)"
- ext: github.link
icon: fa-github
text: Code Repository (GitHub)
include: true
- ext: repo.link
icon: fa-code-fork
text: Code Repository
include: true
../publications/_publication_file_types.yml
\ No newline at end of file
Subproject commit 4553e4ef5241df298fd4355dac23ef08bd974f9b
Paper Downloads
===============
Papers and supporting supplementary material should be placed in this directory.
Check with the publisher's T&Cs to determine which version of the paper you are allowed to publish here. Often it is
only the pre-print edition that is passed to the publisher **before** they make any changes. The final proof copy and
the publisher's own copy is often not permitted to be published.
The paper should also be deposited into [Imperial Spiral](http://spiral.imperial.ac.uk/).
Files should be named by their key in the publications BibTeX file, suffixed with the appropriate extension.
Technical reports should be named as ***bibtex_key***.techreport.***ext***
Additional file types are also supportable, see [the README in the website root (as published
online)](https://psvg.doc.ic.ac.uk/README.html) for the full list.
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment