Merge branch 'main' of github.com:zebbra/neops

Author: leandrolerena

.github/workflows/gh-pages.yml

@@ -1,17 +1,20 @@
 # Simple workflow for deploying static content to GitHub Pages
-name: Deploy static content to Pages
+name: Deploy Neops Documentation
 
 on:
   # Runs on pushes targeting the default branch
   push:
     branches: ["main"]
 
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
+  schedule:
+    - cron: '0 */3 * * *'  # Runs every 3 hours
 
   repository_dispatch:
     types: [ trigger ]  # You can specify a custom event type
 
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
 permissions:
   contents: read
   pages: write

Dockerfile

@@ -2,8 +2,8 @@ include ./make_scripts/mkdocs-documentation/mkdocs-documentation-makefile.mk
 
 update-submodules:
 	echo "Updating submodules"
-#	git submodule init
-#	git submodule update --remote
-#	git submodule foreach 'git checkout main'
-#	git submodule foreach 'git pull'
-#
+	git submodule init
+	git submodule foreach 'git fetch'
+	git submodule foreach 'git checkout develop'
+	git submodule foreach 'git pull'
+

Makefile

@@ -14,4 +14,3 @@ This repository does not contain product code, but serves as an entry point for
 ## Contribute to documentation
 
 Everybody is welcome to contribute to the documentation!
-

README.md

@@ -1,5 +1,7 @@
 # Neops product documentation
 
+[![Neops Documentation](https://github.com/zebbra/neops/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/zebbra/neops/actions/workflows/gh-pages.yml)
+
 Neops represents a groundbreaking approach to network power that transcends traditional task automation. 
 It’s designed to enhance productivity, enabling you to focus on what you do best—your core competencies. 
 With Neops, you’ll experience a seamless integration of intelligent solutions that streamline operations 

docs/index.md

@@ -6,13 +6,14 @@ RUN pip install poetry
 
 COPY . .
 
-RUN poetry --directory make_scripts/mkdocs-documentation/ install
+RUN poetry --project make_scripts/mkdocs-documentation/ install
 
 
 # We need the .git repository to get authors and last-modified dates 
 COPY .git .git
 
 RUN make doc-build
+RUN make doc-site-clean
 
 FROM nginxinc/nginx-unprivileged:1.19
 

docs/scripts

@@ -0,0 +1,22 @@
+import os
+import pathspec
+
+# Define the directory to clean and the ignore file (like .gitignore)
+directory_to_clean = 'site'
+ignore_file = f"{os.path.dirname(__file__)}/mkdocsignore"  # Path to your ignore file
+
+if __name__ == '__main__':
+    # Read the patterns from the ignore file
+    with open(ignore_file, 'r') as f:
+        ignore_patterns = f.read().splitlines()
+
+    # Create a PathSpec object using the ignore patterns
+    spec = pathspec.PathSpec.from_lines(pathspec.patterns.GitWildMatchPattern, ignore_patterns)
+
+    # Walk through the directory and delete files that match the ignore patterns
+    for root, dirs, files in os.walk(directory_to_clean):
+        for file in files:
+            file_path = os.path.relpath(os.path.join(root, file), directory_to_clean)
+            if spec.match_file(file_path):  # Check if the file matches any ignore pattern
+                print(f"Deleting {file_path}")
+                os.remove(os.path.join(root, file))

make_scripts/mkdocs-documentation/Dockerfile

@@ -17,5 +17,5 @@ git submodule add your-repo-name
 
 ## Reference
 
-- Markdown/Material for MkDocs: https://squidfunk.github.io/mkdocs-material/reference/
-- Snippets: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
+- [Markdown/Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/)
+- [Usage of Snippets](https://facelessuser.github.io/pymdown-extensions/extensions/snippets/)

make_scripts/mkdocs-documentation/clean_sites_directory.py

@@ -1,22 +1,25 @@
 .PHONY: doc-update-assets doc-create-mkdocs doc-serve doc-build
 
+MKDOCS_ENV=./make_scripts/mkdocs-documentation
+
 doc-update-assets:
-	./make_scripts/mkdocs-documentation/setup_documentation.sh
+	$(MKDOCS_ENV)/setup_documentation.sh
 
 doc-create-mkdocs:
-	poetry run --directory make_scripts/mkdocs-documentation/ python make_scripts/mkdocs-documentation/setup_documentation.py
+	poetry run --project $(MKDOCS_ENV)/ python $(MKDOCS_ENV)/setup_documentation.py
 
 doc-serve:
-	poetry run --directory make_scripts/mkdocs-documentation/ python make_scripts/mkdocs-documentation/setup_documentation.py
-	poetry run --directory make_scripts/mkdocs-documentation/  mkdocs serve
+	poetry install --project $(MKDOCS_ENV)/
+	poetry run --project $(MKDOCS_ENV)/ python $(MKDOCS_ENV)/setup_documentation.py
+	poetry run --project $(MKDOCS_ENV)/  mkdocs serve
 
 doc-build:
-	poetry run --directory make_scripts/mkdocs-documentation/ python make_scripts/mkdocs-documentation/setup_documentation.py
-	poetry run --directory make_scripts/mkdocs-documentation/  mkdocs build
+	poetry run --project $(MKDOCS_ENV)/ python $(MKDOCS_ENV)/setup_documentation.py
+	poetry run --project $(MKDOCS_ENV)/  mkdocs build
+	poetry run --project $(MKDOCS_ENV)/ python $(MKDOCS_ENV)/clean_sites_directory.py
 
 doc-build-docker:
-	docker build --file make_scripts/mkdocs-documentation/Dockerfile .
+	docker build --file $(MKDOCS_ENV)/Dockerfile .
 
-#doc-build-strict:
-#	poetry run --directory make_scripts/mkdocs-documentation/ python make_scripts/mkdocs-documentation/setup_documentation.py
-#	poetry run --directory make_scripts/mkdocs-documentation/  mkdocs build --strict
+doc-site-clean:
+	poetry run --project $(MKDOCS_ENV)/ python $(MKDOCS_ENV)/clean_sites_directory.py