From 7832920148713003b154489c84857b55ec057a7f Mon Sep 17 00:00:00 2001 From: "Esteban J. G. Gabancho" Date: Sat, 16 Mar 2024 14:42:48 -0400 Subject: [PATCH] Initial content --- .github/workflows/ci.yml | 30 ++++++++++++++++++++++++++++++ .gitignore | 8 ++++++++ CONTRIBUTING.md | 17 +++++++++++++++++ LICENSE | 21 +++++++++++++++++++++ README.md | 37 ++++++++++++++++++++++++++++++++++++- docs/.gitkeep | 0 mkdocs.yml | 22 ++++++++++++++++++++++ scripts/bootstrap | 10 ++++++++++ scripts/server | 5 +++++ 9 files changed, 149 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/ci.yml create mode 100644 .gitignore create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 docs/.gitkeep create mode 100644 mkdocs.yml create mode 100755 scripts/bootstrap create mode 100755 scripts/server diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..bb48b71 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,30 @@ +name: ci +on: + push: + branches: + - master + - main +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + - run: pip install mkdocs-material + - run: cp README.md docs/index.md + - run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2a6e7f0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +.DS_Store + +docs/index.md +site/ + +.venv +.envrc +.tools-versions diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4d64a68 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing + +Your contributions are always welcome! + +## Guidelines + +* Add one link per Pull Request. + * Make sure the PR title is in the format of `Add project-name`. + * Write down the reason why it is awesome. +* Add the link: `* [project-name](http://example.com/) - A short description ends with a period.` + * Keep descriptions concise and **short**. +* Add a section if needed. + * Add the section description. + * Add the section title to Table of Contents. +* Search previous Pull Requests or Issues before making a new one, as yours may be a duplicate. +* Check your spelling and grammar. +* Remove any trailing whitespace. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3490b5e --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Esteban J. G. Gabancho + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 4697ee6..495e369 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -# awesome-invenio \ No newline at end of file +# Awesome Invenio + +An opinionated list of awesome Invenio extensions, overlays and resources. + +Inspired by [awesome-python](https://github.com/vinta/awesome-python). + +--- + +## Overlays + +* [CaltechDATA](https://github.com/caltechlibrary/caltechdata) - The CaltechDATA InvenioRDM source code. +* [CDS](https://github.com/CERNDocumentServer/cds-rdm) - New CDS site based on InvenioRDM. + +## Deployments + +* [TU Graz Deployment](https://tu-graz-library.github.io/docs-repository) - Docker compose based deployment. + +# Resources + +## Official Channels + +* [Discord Server](https://discord.gg/8qatqBC) +* [Forum](https://invenio-talk.web.cern.ch/) + +# Contributing + +Your contributions are always welcome! Please take a look at the +[contribution guidelines](https://github.com/egabancho/awesome-invenio/blob/master/CONTRIBUTING.md) +first. + +- - - + +If you have any question about this opinionated list, do not hesitate to contact me +[@egabancho@fosstodon.org ](https://fosstodon.org/@egabancho) on Mastodont or open +an issue on GitHub. + diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..735419e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,22 @@ +site_name: Awesome Invenio +site_url: https://awesome-invenio.com +site_description: An opinionated list of awesome Invenio extensions, overlays and resources. +site_author: Esteban J. G. Gabancho +repo_name: egabancho/awesome-invenio +repo_url: https://github.com/egabancho/awesome-invenio +theme: + name: material + palette: + primary: blue + accent: pink +markdown_extensions: + - toc: + permalink: true +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/egabanho + - icon: fontawesome/brands/mastodon + link: https://fosstodon.org/@egabancho + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/in/egabancho \ No newline at end of file diff --git a/scripts/bootstrap b/scripts/bootstrap new file mode 100755 index 0000000..3ef2195 --- /dev/null +++ b/scripts/bootstrap @@ -0,0 +1,10 @@ +#!/usr/bin/env bash + +set -e + +script_path=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) + +echo $script_path + +pip install mkdocs-material +ln -sf $script_path/../README.md $script_path/../docs/index.md \ No newline at end of file diff --git a/scripts/server b/scripts/server new file mode 100755 index 0000000..c7a41f8 --- /dev/null +++ b/scripts/server @@ -0,0 +1,5 @@ +#!/usr/bin/env bash + +set -e + +mkdocs serve \ No newline at end of file