Skip to content

Commit

Permalink
🔧 (config): add configuration files for project setup and management
Browse files Browse the repository at this point in the history
Introduce several configuration files to enhance project setup and management:
- `.gitattributes` to ensure consistent text file handling across different OS.
- `.spellcheck.yml` and `.wordlist.txt` for spell checking markdown files.
- `.gitignore` to exclude unnecessary files and directories from version control.
- `.prettierrc` for code formatting standards.
- `LICENCE` to define the project's licensing terms.
- `hugo.yaml` for Hugo site configuration.
- `robots.txt` for search engine crawling instructions.
- `staticwebapp.config.json` for Azure Static Web Apps configuration.

These changes aim to standardize development practices, improve code quality, and ensure proper project documentation and licensing.
  • Loading branch information
MrHinsh committed Nov 14, 2024
1 parent 03c9e5d commit 12d9739
Show file tree
Hide file tree
Showing 12 changed files with 2,101 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto
22 changes: 22 additions & 0 deletions .github/.spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
matrix:
- name: Markdown
sources:
- "**/*.md"
- "*.md"
default_encoding: utf-8
aspell:
lang: en
dictionary:
wordlists:
- .wordlist.txt
encoding: utf-8
pipeline:
- pyspelling.filters.markdown
- pyspelling.filters.stylesheets
- pyspelling.filters.url
- pyspelling.filters.html:
comments: false
ignores:
- code
- pre
- blockquote
2 changes: 2 additions & 0 deletions .github/.wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Mailchimp
stylesheet
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# ignore directories
/public/
/site/public/
**/.obsidian/
**/_gen/
/resources/
/.processing/
Empty file added .hugo_build.lock
Empty file.
15 changes: 15 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"plugins": ["prettier-plugin-go-template"],
"overrides": [
{
"files": ["*.html"],
"options": {
"parser": "go-template"
}
}
],
"goTemplateBracketSpacing": true,
"bracketSameLine": true,
"printWidth": 255,
"formatOnSave": true
}
395 changes: 395 additions & 0 deletions LICENCE

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "The SAFe Delusion"
url: "/"
---

53 changes: 53 additions & 0 deletions hugo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
languageCode: en
title: The Safe Delusion

publishDir: ../public
resourceDir: ../resources

summaryLength: 30

enableRobotsTXT: true

# Site-wide parameters
params:
description: "Information for decision-makers considering the SAFe framework - Curated review of facts, evidence, and opinions from relevant sources without vested interests, to help decision-makers make informed choices and get better results"
keywords: "SAFe, Scaled Agile Framework, Agile"
og_image: "/images/og-image.jpg" # URL to the default Open Graph image
editURL: "https://github.com/nkdAgility/the-safe-delusion/edit/main/site/content/" # URL to edit content on GitHub

# Enable sitemap and robots.txt
sitemap:
filename: "sitemap.xml"
changefreq: "daily"
priority: 0.5

# RSS feed settings
rss:
filename: "rss.xml"
name: "RSS Feed"
description: "Subscribe to our RSS feed"

outputs:
home: [html, json, rss]
section: [html, rss]
taxonomy: [html, rss]
term: [html, rss]
page: [html, rss]

outputFormats:
json:
mediaType: "application/json"
baseName: "pages"

markup:
goldmark:
renderer:
unsafe: true # Allows raw HTML in Markdown
extensions:
table: true
linkify: true
typographer: true
parser:
attribute:
block: true
title: true
1,574 changes: 1,574 additions & 0 deletions layouts/index.html

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions layouts/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Robots File {{hugo.Environment}}
{{ if eq hugo.Environment "production" }}
User-agent: *
Allow: /
Sitemap: {{ "/sitemap.xml" | absURL }}
{{ else }}
User-agent: *
Disallow: /
{{ end }}


16 changes: 16 additions & 0 deletions staticwebapp.config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"platform": {
"apiRuntime": "dotnet-isolated:8.0"
},
"auth": {
"identityProviders": {
"github": {
"registration": {
"clientIdSettingName": "GITHUB_CLIENT_ID",
"clientSecretSettingName": "GITHUB_CLIENT_SECRET"
}
}
}
},
"routes": []
}

0 comments on commit 12d9739

Please sign in to comment.