Skip to content

Commit

Permalink
Move FSHSchool site to GitHub FHIR organization (#105)
Browse files Browse the repository at this point in the history
* Replace links as necessary to point to correct locations for FSHOnline, FSH Finder, and Courses.
* Update GitHub links to point to new location of site repo.
* Update deployment to deploy to gh-pages branch (default) instead of separate fshschool.github.io repo.
* Add custom 404 page to automatically redirect link to /FSHOnline, /fsh-finder, and /courses to their new web locations. (Note, redirects only work on GH pages; they do not work for local deployment).
  • Loading branch information
cmoesel authored Sep 21, 2024
1 parent f036d1c commit c94774e
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 24 deletions.
10 changes: 4 additions & 6 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ on:
push:
branches:
- master
workflow_dispatch:

jobs:
deploy:
Expand All @@ -14,7 +15,7 @@ jobs:
fetch-depth: 0

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
uses: peaceiris/actions-hugo@v3
with:
hugo-version: '0.74.2'
extended: true
Expand All @@ -37,12 +38,9 @@ jobs:
- run: hugo

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
with:
personal_token: ${{ secrets.TOKEN }}
external_repository: FSHSchool/FSHSchool.github.io
publish_branch: master
publish_dir: ./public
github_token: ${{ secrets.GITHUB_TOKEN }}
cname: fshschool.org
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# FSH School

The FSH School website is built using [Hugo](https://themes.gohugo.io/hugo-theme-learn/) and
deployed to [http://fshschool.org/](http://fshschool.org/) and [https://fshschool.github.io/](https://fshschool.github.io/) via GitHub Actions that
build the site and push its contents to the
[FSHSchool.github.io](https://github.com/FSHSchool/FSHSchool.github.io) repository.
deployed to [http://fshschool.org/](http://fshschool.org/) via GitHub Actions that build the site
and push its contents to the [gh-pages](https://github.com/FHIR/FSHSchool/tree/gh-pages) branch.

## FHIR Foundation Project Statement

- Maintainers: This project is maintained by the HL7 community.
- Issues / Discussion: For FSH School website issues, such as bug reports, comments, suggestions, questions, and feature requests, visit [FSH School website GitHub Issues](https://github.com/FSHSchool/site/issues). For discussion of FHIR Shorthand and its associated projects, visit the FHIR Community Chat @ https://chat.fhir.org. The [#shorthand stream](https://chat.fhir.org/#narrow/stream/215610-shorthand) is used for all FHIR Shorthand questions and discussion.
- Issues / Discussion: For FSH School website issues, such as bug reports, comments, suggestions, questions, and feature requests, visit [FSH School website GitHub Issues](https://github.com/FHIR/FSHSchool/issues). For discussion of FHIR Shorthand and its associated projects, visit the FHIR Community Chat @ https://chat.fhir.org. The [#shorthand stream](https://chat.fhir.org/#narrow/stream/215610-shorthand) is used for all FHIR Shorthand questions and discussion.
- License: All contributions to this project will be released under the Apache 2.0 License, and a copy of this license can be found in [LICENSE](LICENSE).
- Contribution Policy: The FSH School website Contribution Policy can be found in [CONTRIBUTING.md](CONTRIBUTING.md).
- Security Information: The FSH School website Security Information can be found in [SECURITY.md](SECURITY.md).
Expand All @@ -20,7 +19,7 @@ To develop this site locally:

1. Clone this repository
```bash
$ git clone git@github.com:FSHSchool/site.git
$ git clone git@github.com:FHIR/FSHSchool.git
```
and add submodules
```bash
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Reporting security issues privately

To report a security issue privately, please [create a security advisory](https://github.com/FSHSchool/site/security/advisories) in this repository. This will allow repository administrators to review and address it privately before public disclosure. For more details about this process, see ["Privately reporting a security vulnerability"](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability).
To report a security issue privately, please [create a security advisory](https://github.com/FHIR/FSHSchool/security/advisories) in this repository. This will allow repository administrators to review and address it privately before public disclosure. For more details about this process, see ["Privately reporting a security vulnerability"](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability).

# Project security practices

Expand Down
8 changes: 4 additions & 4 deletions config.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
baseURL = "/"
baseURL = "https://fshschool.org/"
title = "FSH School"

enableRobotsTXT = true
Expand Down Expand Up @@ -65,9 +65,9 @@ id = "UA-00000000-0"
copyright = "Health Level Seven International"

# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/FSHSchool/site"
github_repo = "https://github.com/FHIR/FSHSchool"
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
github_project_repo = "https://github.com/fhir/sushi"
github_project_repo = "https://github.com/FHIR/sushi"

# Google Custom Search Engine ID. Remove or comment out to disable search.
# gcs_engine_id = "011737558837375720776:fsdu1nryfng"
Expand Down Expand Up @@ -122,7 +122,7 @@ enable = false
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
[[params.links.developer]]
name = "FSH School"
url = "https://github.com/FSHSchool/site"
url = "https://github.com/FHIR/FSHSchool"
icon = "fab fa-github"
desc = "Development of this site takes place here."
[[params.links.developer]]
Expand Down
8 changes: 4 additions & 4 deletions content/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Read the Docs <i class="fas fa-book-open ml-2"></i>
</a>
<a class="btn btn-lg btn-secondary mr-3 mb-4" target="_blank" href="/FSHOnline/">
<a class="btn btn-lg btn-secondary mr-3 mb-4" target="_blank" href="https://fshonline.fshschool.org/">
Play With FSH <i class="fas fa-fish "></i>
</a>
<a class="btn btn-lg btn-info mr-3 mb-4" target="_blank" href="/courses/">
<a class="btn btn-lg btn-info mr-3 mb-4" target="_blank" href="https://fshschool.github.io/courses/">
Online Course <i class="fas fa-graduation-cap "></i>
</a>
<a class="btn btn-lg btn-danger mr-3 mb-4" target="_blank" href="/fsh-finder/">
<a class="btn btn-lg btn-danger mr-3 mb-4" target="_blank" href="https://fshschool.github.io/fsh-finder/">
Who Else Is FSHing? <i class="fas fa-ship "></i>
</a>
<p class="lead mt-3">The place to learn and try FHIR Shorthand</p>
Expand All @@ -40,7 +40,7 @@
{{% /blocks/feature %}}

{{% blocks/feature icon="fas fa-fire" title="Fast and Agile" %}}
FSH is amazingly compact, fun to write, and painless to modify when you need to make changes.
FSH is amazingly compact, fun to write, and painless to modify when you need to make changes.
Take a look at the official <a href="http://hl7.org/fhir/uv/shorthand/" target="_blank">FSH specification</a> for more information about how FSH can be used to profile FHIR.
{{% /blocks/feature %}}

Expand Down
2 changes: 1 addition & 1 deletion content/docs/SUSHI/tutorial/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: >
[FHIR Shorthand](https://build.fhir.org/ig/HL7/fhir-shorthand/index.html) (FSH) is a specially-designed language for defining the content of FHIR Implementation Guides (IGs). It is simple and compact, with tools to produce Fast Healthcare Interoperability Resources (FHIR) profiles, extensions and IGs. FSH is compiled from text files to FHIR artifacts using [SUSHI](/docs/sushi). To get started using FSH, you need to install and run SUSHI using the steps below.

{{% alert title="Tip" color="success" %}}
If you find this helpful, you may also want to look at our [self-service FSH Seminar course](/courses/), which includes a more extensive walkthrough of using SUSHI and FSH.
If you find this helpful, you may also want to look at our [self-service FSH Seminar course](https://fshschool.github.io/courses/), which includes a more extensive walkthrough of using SUSHI and FSH.
{{% /alert %}}

### Step 1: Review Introduction
Expand Down
4 changes: 2 additions & 2 deletions content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ In addition, the following symbols are used in documented commands:

### FHIR and FHIR Profiling

Most FSH School resources assume a basic understanding of FHIR and FHIR profiling. A good way to get started is to go through our [**self-service FSH Seminar course**: Getting Started with New Tools to Create Swimmingly Slick Implementation Guides](/courses/). This covers how to read FHIR IGs and how to use FSH for [FHIR Profiling](https://hl7.org/fhir/profiling.html).
Most FSH School resources assume a basic understanding of FHIR and FHIR profiling. A good way to get started is to go through our [**self-service FSH Seminar course**: Getting Started with New Tools to Create Swimmingly Slick Implementation Guides](https://fshschool.github.io/courses/). This covers how to read FHIR IGs and how to use FSH for [FHIR Profiling](https://hl7.org/fhir/profiling.html).

Readers who are new to FHIR should also view the [FHIR Specification](https://hl7.org/fhir/) (also linked in the right-hand sidebar). You may find the following more specific links helpful as well:

Expand All @@ -83,4 +83,4 @@ Additionally, these other resources may be of interest:

We recommend new FSH authors start with the [overview](https://hl7.org/fhir/uv/shorthand/) and review the [language reference](https://hl7.org/fhir/uv/shorthand/reference.html) that are part of official FSH Specification when additional details are needed.

Additionally, *all* FSH authors are strongly recommended to go on the [Deep Dive with FSH](https://fshschool.org/courses/fsh-seminar/04-deep-dive-with-fsh.html) (part of our [self-service FSH Seminar course](/courses/)).
Additionally, *all* FSH authors are strongly recommended to go on the [Deep Dive with FSH](https://fshschool.github.io/courses/fsh-seminar/04-deep-dive-with-fsh.html) (part of our [self-service FSH Seminar course](https://fshschool.github.io/courses/)).
23 changes: 23 additions & 0 deletions layouts/404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{{ define "main" }}
<main id="main">
<div id="content">
<h1 id="title">Not found</h1>
<p>Oops! This page doesn't exist. Try going back to our <a href="{{ "/" | relURL }}">home page</a>.</p>
</div>
<script>
window.onload = function () {
if (/^\/FSHOnline(\/|$)/i.test(window.location.pathname)) {
// redirect to the new location of courses
const newLocation = `${window.location.protocol}{{ "//fshonline.fshschool.org" | safeJS }}${window.location.pathname.replace(/^\/FSHOnline/i, '')}${window.location.hash || ''}`;
document.getElementById("content").innerHTML = `Redirecting to ${newLocation}`;
window.location.replace(newLocation);
} else if (/^\/(courses|fsh-finder)(\/|$)/i.test(window.location.pathname)) {
// redirect to the new location of courses or fsh-finder
const newLocation = `${window.location.protocol}{{ "//fshschool.github.io" | safeJS }}${window.location.pathname}${window.location.hash || ''}`;
document.getElementById("content").innerHTML = `Redirecting to ${newLocation}`;
window.location.replace(newLocation);
}
}
</script>
</main>
{{ end }}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "0.0.1",
"repository": {
"type": "git",
"url": "https://github.com/FSHSchool/site.git"
"url": "https://github.com/FHIR/FSHSchool.git"
},
"scripts": {
"zip-tutorial": "zip -r content/docs/SUSHI/tutorial/fsh-tutorial.zip fsh-tutorial/*"
Expand Down

0 comments on commit c94774e

Please sign in to comment.