diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index bae05ab..29d6f91 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -2,43 +2,38 @@ name: CI # Controls when the workflow will run on: - # Triggers the workflow on push or pull request events but only for the main branch + # Triggers the workflow on push events for the main branch push: - branches: [ main ] - pull_request: - branches: [ main ] + branches: [ mkdocs ] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: +# Needs write permission to update the gh-pages branch that is used for GitHub Pages +permissions: + contents: write + # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: # This workflow contains a single job called "build" - build: - # The type of runner that the job will run on + # Copied from https://squidfunk.github.io/mkdocs-material/publishing-your-site/ + deploy: runs-on: ubuntu-latest - - env: - STPATOOLS_VERSION: "42e07abc5510f5864aa102aa7ae1e8349911a620" - STPATOOLS_REPO: "https://gitlab.com/CodethinkLabs/stpatools.git" - - # Steps represent a sequence of tasks that will be executed as part of the job steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - uses: actions/checkout@v2 - - # Check that YAML files are well-formed - - name: YAML lint - run: yamllint -d relaxed . - - # Install specific version of ruamel.yaml required by STPAtools - - name: Install ruamel.yaml - run: pip3 install ruamel.yaml==0.16.7 - - # Install specific version of STPA tools from repo - - name: Install STPA tools - run: pip3 install "git+${{env.STPATOOLS_REPO}}@${{env.STPATOOLS_VERSION}}" - - # Validate STPA files - - name: Validate STPA files (STPA_DynMA) - run: stpa-validate STPA_DynMA/*.yml + - 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: mkdocs gh-deploy --force diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..09c6e78 --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +osep.elisa.tech diff --git a/docs/images/elisa-horizontal-color.svg b/docs/images/elisa-horizontal-color.svg new file mode 100644 index 0000000..1c058e1 --- /dev/null +++ b/docs/images/elisa-horizontal-color.svg @@ -0,0 +1,190 @@ + + diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico new file mode 100644 index 0000000..978b94d Binary files /dev/null and b/docs/images/favicon.ico differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..d4c1f67 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,6 @@ +# ELISA OSEP working group + +Welcome to the home of the Open Source Engineering Process (OSEP) working group. + +OSEP is a working groups of the Linux Foundation's +[Enabling Linux In Safety Applications (ELISA)](https://elisa.tech/) project. diff --git a/docs/stylesheets/elisa.css b/docs/stylesheets/elisa.css new file mode 100644 index 0000000..67d744a --- /dev/null +++ b/docs/stylesheets/elisa.css @@ -0,0 +1,11 @@ +:root { + + --elisa-green: #77c046; + + --md-default-fg-color: slategrey; + --md-default-bg-color: white; + + --md-primary-fg-color: black; + --md-primary-bg-color: var(--elisa-green); + + } diff --git a/docs/workshops/2021-11-Virtual/Certification-using-the-New-Approach-to-Safety.pdf b/docs/workshops/2021-11-Virtual/Certification-using-the-New-Approach-to-Safety.pdf new file mode 100644 index 0000000..a42a8e9 Binary files /dev/null and b/docs/workshops/2021-11-Virtual/Certification-using-the-New-Approach-to-Safety.pdf differ diff --git a/docs/workshops/2023-06-Berlin/Safety-Analysis-Approach.pdf b/docs/workshops/2023-06-Berlin/Safety-Analysis-Approach.pdf new file mode 100644 index 0000000..efe074c Binary files /dev/null and b/docs/workshops/2023-06-Berlin/Safety-Analysis-Approach.pdf differ diff --git a/docs/workshops/2023-10-Munich/A-Systematic-Approach-to-Using-the-Linux-Kernel-in-a-Safety-Scenario.pdf b/docs/workshops/2023-10-Munich/A-Systematic-Approach-to-Using-the-Linux-Kernel-in-a-Safety-Scenario.pdf new file mode 100644 index 0000000..0165f4b Binary files /dev/null and b/docs/workshops/2023-10-Munich/A-Systematic-Approach-to-Using-the-Linux-Kernel-in-a-Safety-Scenario.pdf differ diff --git a/docs/workshops/2023-10-Munich/Update-on-Planned-Processes-for-Safety-Analysis-and-Documentation-of-Results.pdf b/docs/workshops/2023-10-Munich/Update-on-Planned-Processes-for-Safety-Analysis-and-Documentation-of-Results.pdf new file mode 100644 index 0000000..23841cc Binary files /dev/null and b/docs/workshops/2023-10-Munich/Update-on-Planned-Processes-for-Safety-Analysis-and-Documentation-of-Results.pdf differ diff --git a/docs/workshops/2024-06-Lund/Overall-engineering-approach-to-safety-with-systems-involving-Linux.pdf b/docs/workshops/2024-06-Lund/Overall-engineering-approach-to-safety-with-systems-involving-Linux.pdf new file mode 100644 index 0000000..0084da2 Binary files /dev/null and b/docs/workshops/2024-06-Lund/Overall-engineering-approach-to-safety-with-systems-involving-Linux.pdf differ diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c502f20 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,31 @@ +site_name: ELISA OSEP +repo_url: https://github.com/elisa-tech/wg-osep +site_url: https://osep.elisa.tech/ +site_dir: public + +theme: + name: material + logo: images/elisa-horizontal-color.svg + favicon: images/favicon.ico + icon: + repo: fontawesome/brands/gitlab + font: + text: Open Sans + code: Fira Code + features: + - content.code.copy + - content.code.annotate + - navigation.footer + - navigation.top + +extra_css: + - stylesheets/elisa.css + +use_directory_urls: false + +plugins: + - search + +nav: + - ELISA: https://elisa.tech/ + - Home: index.md