Skip to content

Commit

Permalink
Disable meta data elements in adr-template (#12074)
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor authored Oct 24, 2024
1 parent 404394f commit ee5d78b
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
9 changes: 5 additions & 4 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ on:
- 'docs/**'
- '.github/workflows/pages.yml'
push:
branches:
main
paths:
- 'docs/**'
- '.github/workflows/pages.yml'
Expand All @@ -17,9 +19,8 @@ permissions:
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
group: "${{ github.workflow }}-${{ github.head_ref || github.ref }}"
cancel-in-progress: true

jobs:
Expand All @@ -33,9 +34,9 @@ jobs:
- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '2.7' # Not needed with a .ruby-version file
ruby-version: '3.3' # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 1 # Increment this number if you need to re-download cached gems
cache-version: 0 # Increment this number if you need to re-download cached gems
working-directory: docs/
- name: Setup Pages
id: pages
Expand Down
4 changes: 2 additions & 2 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
source 'https://rubygems.org'

gem "jekyll", "~> 4.3" # installed by `gem jekyll`
gem "jekyll", "~> 4.3.4" # installed by `gem jekyll`

# Homepage: https://github.com/paulrobertlloyd/jekyll-figure#jekyll-figure
gem 'jekyll-figure'

gem "just-the-docs", "0.5.0"
gem "just-the-docs", "0.10.0"

gem "jekyll-remote-theme"

Expand Down
10 changes: 5 additions & 5 deletions docs/decisions/adr-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ nav_order: 100
parent: Decision Records

# These are optional metadata elements. Feel free to remove any of them.
status: "{proposed | rejected | accepted | deprecated | … | superseded by ADR-0123"
date: {YYYY-MM-DD when the decision was last updated}
decision-makers: {list everyone involved in the decision}
consulted: {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication}
informed: {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication}
# status: "{proposed | rejected | accepted | deprecated | … | superseded by ADR-0123"
# date: {YYYY-MM-DD when the decision was last updated}
# decision-makers: {list everyone involved in the decision}
# consulted: {list everyone whose opinions are sought (typically subject-matter experts); and with whom there is a two-way communication}
# informed: {list everyone who is kept up-to-date on progress; and with whom there is a one-way communication}
---
<!-- we need to disable MD025, because we use the different heading "ADR Template" in the homepage (see above) than it is foreseen in the template -->
<!-- markdownlint-disable-next-line MD025 -->
Expand Down

0 comments on commit ee5d78b

Please sign in to comment.