cleanup

.devcontainer/devcontainer.json → .devcontainer.json

@@ -1,8 +1,8 @@
 {
-	"name": "HACS Documentation",
+	"name": "hacs/doumentation",
 	"image": "mcr.microsoft.com/vscode/devcontainers/javascript-node:18",
-	"context": "..",
-	"postStartCommand": "make init",
+	"context": ".",
+	"postCreateCommand": "scripts/setup",
 	"settings": { 
 		"terminal.integrated.shell.linux": "/bin/bash",
 		"editor.defaultFormatter": "esbenp.prettier-vscode",
@@ -12,9 +12,10 @@
 		  "editor.formatOnSave": false  
 		}
 	},
-	"appPort": ["3000:3000"],
-	"postCreateCommand": "make init",
+	"forwardPorts": [3000],
+
 	"extensions": [
-		"dbaeumer.vscode-eslint"
+		"dbaeumer.vscode-eslint",
+		"esbenp.prettier-vscode"
 	]
 }

.github/workflows/actions.yml

@@ -16,8 +16,5 @@ jobs:
       - name: 📦 Checkout the repository
         uses: actions/checkout@v2
 
-      - name: 📦 Set up Python
-        uses: actions/setup-python@v2
-
       - name: ✅ Run pre-commit
         uses: pre-commit/[email protected]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 HACS
+Copyright (c) 2023 HACS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

documentation/developer/documentation.md

@@ -13,7 +13,7 @@ There are two ways of contributing to the documentation:
 - Using the "Edit this page" link at the bottom of every page.
 - Locally changing (devcontainer)
 
-_All changes to the documentation should go against the `master` branch._  
+_All changes to the documentation should go against the `main` branch._  
 The repository for the documentation is hosted @ https://github.com/hacs/documentation
 
 ### Edit this page
@@ -31,7 +31,7 @@ First spin up the [devcontainer](/docs/developer/devcontainer)
 When you have that running issue the following commands:
 
 ```bash
-yarn start
+scripts/develop
 ```
 
 You have now started a local webserver that hosts the documentation on http://localhost:3000
@@ -85,8 +85,8 @@ Then you need to use:
 
 ## New pages
 
-1. Create a new `.md` file under `documentation/content/` in a sub-directory that fits the purpose of the file.
-1. Add a reference to that file in `documentation/sidebars.js`
+1. Create a new `.md` file under `documentation/` in a sub-directory that fits the purpose of the file.
+1. Add a reference to that file in `sidebars.js`
 
 At the top of all pages you should have this:
 

scripts/build

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+yarn run build

scripts/develop

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+yarn run start

scripts/setup

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+yarn install