Skip to content

Commit

Permalink
Release comments
Browse files Browse the repository at this point in the history
Relase v1.0.0 has been made. There were some minor changes necessary

  1. Update the README to explain how the document is organised and built.
  1. Update the `bibliography.yaml` file
  • Loading branch information
brucellino committed Jun 13, 2017
1 parent 14092e4 commit 1d588c9
Show file tree
Hide file tree
Showing 3 changed files with 1,087 additions and 930 deletions.
10 changes: 0 additions & 10 deletions D1.3-e-Infra-Sentinel-Report.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,6 @@ references:
- family: Abossé
given: Akue-Kpakpo
container-title: "ITU publications on economics & finance"
- id: CHAIN
title:
issued:
year:
month:
url:
doi:
author:
- family:
given:
- id: barbera2014chain
type: article-journal
author:
Expand Down
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,29 @@
[![Build Status](https://travis-ci.org/sci-gaia/D1.3e-Infrastructure-Sentinel-report.svg?branch=master)](https://travis-ci.org/sci-gaia/D1.3e-Infrastructure-Sentinel-report) [![Code Climate](https://codeclimate.com/github/sci-gaia/D1.3e-Infrastructure-Sentinel-report/badges/gpa.svg)](https://codeclimate.com/github/sci-gaia/D1.3e-Infrastructure-Sentinel-report) [![Issue Count](https://codeclimate.com/github/sci-gaia/D1.3e-Infrastructure-Sentinel-report/badges/issue_count.svg)](https://codeclimate.com/github/sci-gaia/D1.3e-Infrastructure-Sentinel-report)


# D1.3e-Infrastructure-Sentinel-report

Deliverable 1.3 - e-Infrastructure Sentinel Report for the Sci-GaIA project http://www.sci-gaia.eu/deliverables/
Deliverable 1.3 - **e-Infrastructure Sentinel Report for the Sci-GaIA project** http://www.sci-gaia.eu/deliverables/

This repository contains the source necessary to build the document.
The document is built with pandoc - see below.

Note :
**Note :**

* The main file is : **D1.3-e-Infra-Sentinel-Report.md**. This is used to build the other formats (pdf, odt - [see below](#building-the-document))
* **Looking for PDF / DOC ?** If you want a pre-compiled document to read, in a `.pdf` or `.odt` file, see the [Github Releases](https://github.com/sci-gaia/D1.3e-Infrastructure-Sentinel-report/releases). This contains the latest succesful build of the document.
* **Looking for PDF / DOC ?** If you want a pre-compiled document to read, in a `.pdf` or `.odt` file, see the [Github Releases](https://github.com/sci-gaia/D1.3e-Infrastructure-Sentinel-report/releases). This contains the latest succesful build of a release of the document.
* **Comments** ? If you would to comment on the document, please open a topic on the forum under the [topic](http://discourse.sci-gaia.eu/t/d1-3-e-infrastructure-sentinel-report/2566)
* **Errors** ? [Open an issue](../issues/new)
* **Contributions** ? If you would like to contribute to the document, please fork the repository and send your suggestions in a pull request.
* **I want to send you contributions in some other way** - whatever works for you, friend - send it over.


# Building the document

[Travis](https://travis-ci.org/sci-gaia/D1.3e-Infrastructure-Sentinel-report) builds the `.odt` and `.pdf` automatically on tagged commits. See the [Travis file](.travis.yml) to see what is done in detail. The following steps are done :

1. Convert images where necessary
2. Conduct spell check
3. Push release on successful build
3. Build the document with pandoc
3. Push release on successful build, if tagged


## Pandoc
Expand Down Expand Up @@ -53,6 +55,10 @@ We use aspell to check the spelling of the document with a custom dictionary kep

`cat D13-e-Infra-Sentinel-Report.md | aspell --pipe --encoding utf-8|grep -v \* | uniq`

# Bibliography

The bibliography used in the document is in `bibliograhy.yaml`. It uses the [citeproc-yaml](https://github.com/jgm/pandoc-citeproc) filter for pandoc.

# Releases

Releases follow a numbering convention as follows :
Expand Down
Loading

0 comments on commit 1d588c9

Please sign in to comment.