Docs v2 WIP

.github/ISSUE_TEMPLATE/track-documentation-task.md

@@ -0,0 +1,34 @@
+---
+name: Track documentation task
+about: Template to track a documentation task
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Description
+
+I'm working on pull request/ issue:
+<!-- Link to PR -->
+
+Supply further description as needed. 
+
+## Research
+<!-- Amend/ add tasks as needed -->
+- [ ] New documents: Collect input from engineers
+- [ ] Existing documents: Get familiar with existing documents
+- [ ] Add more tasks as needed
+
+## Production
+<!-- Amend/ add tasks as needed -->
+- [ ] New documents: Create draft
+- [ ] Existing documents: Refine document
+- [ ] Get technical review
+- [ ] Get peer review
+
+## Publication
+<!-- Amend/ add tasks as needed -->
+- [ ] Merge PR
+- [ ] Approve ingest PR on netdata/learn
+- [ ] Check for broken links in build log

.github/workflows/check-broken-links.md

@@ -0,0 +1,11 @@
+---
+title: Nomad docs contains broken links!
+labels: broken-links
+assignees: ''
+---
+
+## Nomad docs contains broken links!
+
+
+[View the results](https://github.com/nomad-xyz/learn/commit/{{sha}}/checks).
+

.github/workflows/check-broken-links.yml

@@ -0,0 +1,26 @@
+name: Test internal links
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 17 * * *'
+env:
+  WEBSITE_URL: "https://docs.nomad.xyz/"
+  ISSUE_TEMPLATE: ".github/workflows/check-broken-links.md"
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Run BLC on internal links
+      run: npx broken-link-checker $WEBSITE_URL --ordered --recursive --exclude-external --user-agent 'Mozilla/5.0 (Macintosh; Intel Mac OS X 11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.101 Safari/537.36'
+
+    - uses: actions/checkout@v2
+      if: failure()
+
+    - uses: JasonEtco/create-an-issue@v2
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        filename: ${{ env.ISSUE_TEMPLATE }}
+      if: failure()

.gitignore

@@ -1,3 +1,26 @@
-node_modules
-docs/.vitepress/dist
-.DS_STORE
+# Dependencies
+node_modules/
+docs/.vitepress/
+# Production
+/build
+
+# Generated files
+.docusaurus/
+.cache-loader
+
+# Misc
+.DS_Store
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Local Netlify folder
+.netlify
+.vscode/settings.json
+/.idea/

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2022 Illusory Systems Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -1,25 +1,21 @@
-# Documentation Site
+# Nomad Docs
 
-## Install
 
-```sh
-npm install
-```
+## Development
 
-## Build
+- You will need `docusaurus` and `node 16` to develop and test locally the documentation website
+- [Install Docusaurus](https://docusaurus.io/docs/installation)
+- `git clone` the repository locally
+- Run `yarn` or `npm install` from inside the repository to install all dependencies
+- `yarn start`: Will start a local dev server that will automatically reload with every change to the source code
+- Please use named or forked branches. All changes should be PRed to `dev` and if everything works as expected, only then `dev` should be merged into `main`
 
-```sh
-npm run docs:build
-```
+## Deployment
 
-## Serve Dev Environment
+- The docs are automatically deployed from the github repo via Netlify
+    - `main` is deployed to `docs.nomad.xyz`
+    - `dev` is deployed to `dev.docs.nomad.xyz`
 
-```sh
-npm run docs:dev
-```
+## License
 
-## Serve Prod Environment
-
-```sh
-npm run docs:serve
-```
+Apache License 2.0

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {  
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')], 
+};