Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilri/cgspace-submission-guidelines
CGSpace submission guidelines documentation website
https://github.com/ilri/cgspace-submission-guidelines
cgiar cgspace dcterms documentation dublin-core hugo metadata
Last synced: about 2 months ago
JSON representation
CGSpace submission guidelines documentation website
- Host: GitHub
- URL: https://github.com/ilri/cgspace-submission-guidelines
- Owner: ilri
- License: gpl-3.0
- Created: 2021-09-19T05:04:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T09:19:54.000Z (about 2 months ago)
- Last Synced: 2024-11-12T10:26:03.871Z (about 2 months ago)
- Topics: cgiar, cgspace, dcterms, documentation, dublin-core, hugo, metadata
- Language: Python
- Homepage: https://ilri.github.io/cgspace-submission-guidelines
- Size: 1.14 MB
- Stars: 1
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# CGSpace Submission Guidelines
A set of scripts to read `submission-forms.xml` from DSpace and generate documentation about metadata and controlled vocabularies. This is used as guidance for programmatic submission to the [CGSpace repository](https://cgspace.cgiar.org).
You can see the website here: https://ilri.github.io/cgspace-submission-guidelines
## Requirements
Requires the following on the host machine:
- Python 3.10+ and [poetry](https://python-poetry.org/)
- Node.js v16 and npm
- Hugo
## Preparation
Initialize the Python virtual environment with poetry:
```console
$ poetry install --no-root
```
Install dependencies with npm and build the static CSS and JavaScript assets:
```console
$ npm install
$ npm run build
```
## Usage
Make sure the Python virtual environment is active and then run `parse-input-forms.py` to extract and process the DSpace metadata and controlled vocabularies:
```console
$ poetry shell
$ ./util/parse-input-forms.py -i ~/src/git/DSpace/dspace/config/submission-forms.xml -c ~/src/git/DSpace/dspace/config/controlled-vocabularies --clean
```
Generate the documentation site using Hugo:
```console
$ hugo
```
You can view a local development version using `hugo serve`. The site will be available on: http://localhost:1313/cgspace-submission-guidelines/
## License
This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).
The license allows you to use and modify the work for personal and commercial purposes, but if you distribute the work you must provide users with a means to access the source code for the version you are distributing. Read more about the [GPLv3 at TL;DR Legal](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)).