diff --git a/content/blog/2024-03-20-skohub-pages/index.md b/content/blog/2024-03-20-skohub-pages/index.md index 1256729..b21fad2 100644 --- a/content/blog/2024-03-20-skohub-pages/index.md +++ b/content/blog/2024-03-20-skohub-pages/index.md @@ -1,17 +1,47 @@ --- -title: Easier workflow for publishing your vocabularies +title: Publishing SKOS the easy way date: "2024-03-21" authors: [{lastname: "Rörtgen", firstname: "Steffen", id: "https://lobid.org/team/sr#"}] --- -## Simplifying the workflow for publishing vocabularies +## A simple workflow for publishing your SKOS vocab + +With SkoHub Pages we now provide a very simple way for publishing your SKOS vocabulary from a GitHub repository. It only involves [5-6 steps](https://github.com/skohub-io/skohub-pages#usage): + +### Fork the skohub-pages repo. + +**Uncheck the box to only fork the main branch**. + + +### Activate GitHub Actions + +Go to "Actions" tab and if not already activated, activate GitHub Actions. + +### Configue GitHub Pages branch + +Go to "Settings", navigate to the "Pages" setting and select `gh-pages` as the branch your site is being built from. + +## Update pages URL + +Go back to the main page of your repo and click the little gear icon in the top right of the "About" section. Check the box at "Use your GitHub Pages website". + +## Start committing + +Add a commit to the main branch and your vocabulary will be automatically published (sometimes it takes a little to see the changes, remember to do some hard refreshing). + +## Set your GitHub Pages URL as namespace + +See below + + +## Utilizing GitHub Actions & Pages Not all projects or individuals involved in the creation of controlled vocabularies are able or have the resources to run their own infrastructure. Therefore, some time ago we pursued an approach that also makes it possible to use [SkoHub Vocabs](https://github.com/skohub-io/skohub-vocabs) based only on GitHub infrastructure. The workflow is documented in the [SkoHub Pages](https://github.com/skohub-io/skohub-pages) repository. -For this we use the function "[GitHub Pages](https://docs.github.com/de/pages/getting-started-with-github-pages)" and "[GitHub Action](https://docs.github.com/en/actions)" +To make this happen, we utilize "[GitHub Pages](https://docs.github.com/de/pages/getting-started-with-github-pages)" and "[GitHub Actions](https://docs.github.com/en/actions)" With GitHub Pages it is possible to host websites on the GitHub infrastructure. GitHub Actions are used for automated tests and deployments. @@ -20,9 +50,9 @@ The built vocabulary is then pushed to a separate git branch "gh-pages". "GitHub Pages" in turn is configured to deliver HTML pages from this "gh-pages" branch. We have also used this approach in various workshops to introduce SKOS and SkoHub. -However, the workflow was not really user-friendly and required some adjustments in the GitHub action, so that some errors could quickly creep in. +However, the workflow required some adjustments in the GitHub action, so that some errors could quickly creep in. -We have now been able to improve this 🎉 +We are happy to having improved this considerably! 🎉 The relevant information is now set directly as environment variables and all other customizations can be changed via the GitHub GUI, so the workflow is now much more user-friendly. @@ -74,3 +104,6 @@ colour:blue a skos:Concept ; Feel free to try out our simplified approach and let us know if something does not work: +## Outlook: Supporting other forges + +There are lots of reasons why people might not want to use GitHub infrastructure owned by Microsoft for their SKOS publication workflows. That's why we will be looking into replacing as much as possible by generic git-based tooling for triggering the build and will think about providing alternatives for building vocabs on Microsoft servers: https://github.com/skohub-io/skohub-pages/issues/19 \ No newline at end of file