diff --git a/.woodpecker.yml b/.woodpecker.yml index 26da2b2..a17a322 100644 --- a/.woodpecker.yml +++ b/.woodpecker.yml @@ -1,7 +1,7 @@ # .woodpecker.yml steps: - name: build & copy - image: node:18-alpine + image: docker when: - branch: master event: push diff --git a/README.md b/README.md index 559e8de..556b850 100644 --- a/README.md +++ b/README.md @@ -1 +1,3 @@ -A Git-mirrored copy of my [Obsidian](https://obsidian.md/) blog posts, guides, and public notes, served publicly using [Docusaurus](https://github.com/facebook/docusaurus) \ No newline at end of file +![Build Status](https://woodpecker.06222001.xyz/api/badges/5/status.svg) + +A Git-mirrored copy of my [Obsidian](https://obsidian.md/) blog posts, guides, and public notes, served publicly using [Docusaurus](https://github.com/facebook/docusaurus) at [resources.06222001.xyz](https://resources.06222001.xyz) \ No newline at end of file diff --git a/docs/Command Snippets/index.md b/docs/Command Snippets/Command Snippets.md similarity index 100% rename from docs/Command Snippets/index.md rename to docs/Command Snippets/Command Snippets.md diff --git a/docs/Files & Links/index.md b/docs/Files & Links/Files & Links.md similarity index 100% rename from docs/Files & Links/index.md rename to docs/Files & Links/Files & Links.md diff --git a/docs/Guides/Django REST Framework/1 - Setup.md b/docs/Guides/Django REST Framework/1 - Setup.md index 6e7ab93..8bdab08 100644 --- a/docs/Guides/Django REST Framework/1 - Setup.md +++ b/docs/Guides/Django REST Framework/1 - Setup.md @@ -1,15 +1,3 @@ -### Overview -Django is a framework built with Python to help you implement web applications. - -![353e9c415078b3d4a18d7bd93294df1c_MD5](_resources/1%20-%20Setup/353e9c415078b3d4a18d7bd93294df1c_MD5.jpg) - -![8d193fcb83f676cd16e263f78f965bc5_MD5](_resources/1%20-%20Setup/8d193fcb83f676cd16e263f78f965bc5_MD5.jpg) - -Django can be used as-is to develop full stack web apps which include your frontend and backend. This however isn't the focus of this guide. - -You will be using Django alongside Django REST Framework to instead build a backend API, which will only serve data from your database, and not serve as a frontend framework. This guide will focus on data, so no fancy frontend design stuff! - -This guide has concepts that are similar to the official guide for Django linked [here](https://docs.djangoproject.com/en/5.1/intro/tutorial01/). Check it out as well! ### Getting Started diff --git a/docs/Guides/Django REST Framework/Django REST Framework.md b/docs/Guides/Django REST Framework/Django REST Framework.md new file mode 100644 index 0000000..81e6148 --- /dev/null +++ b/docs/Guides/Django REST Framework/Django REST Framework.md @@ -0,0 +1,12 @@ +### Overview +Django is a framework built with Python to help you implement web applications. + +![353e9c415078b3d4a18d7bd93294df1c_MD5](_resources/Django%20REST%20Framework/353e9c415078b3d4a18d7bd93294df1c_MD5.jpg) + +![8d193fcb83f676cd16e263f78f965bc5_MD5](_resources/Django%20REST%20Framework/8d193fcb83f676cd16e263f78f965bc5_MD5.jpg) + +Django can be used as-is to develop full stack web apps which include your frontend and backend. This however isn't the focus of this guide. + +You will be using Django alongside Django REST Framework to instead build a backend API, which will only serve data from your database, and not serve as a frontend framework. This guide will focus on data, so no fancy frontend design stuff! + +This guide has concepts that are similar to the official guide for Django linked [here](https://docs.djangoproject.com/en/5.1/intro/tutorial01/). Check it out as well! \ No newline at end of file diff --git a/docs/Guides/Django REST Framework/_resources/1 - Setup/353e9c415078b3d4a18d7bd93294df1c_MD5.jpg b/docs/Guides/Django REST Framework/_resources/Django REST Framework/353e9c415078b3d4a18d7bd93294df1c_MD5.jpg similarity index 100% rename from docs/Guides/Django REST Framework/_resources/1 - Setup/353e9c415078b3d4a18d7bd93294df1c_MD5.jpg rename to docs/Guides/Django REST Framework/_resources/Django REST Framework/353e9c415078b3d4a18d7bd93294df1c_MD5.jpg diff --git a/docs/Guides/Django REST Framework/_resources/1 - Setup/8d193fcb83f676cd16e263f78f965bc5_MD5.jpg b/docs/Guides/Django REST Framework/_resources/Django REST Framework/8d193fcb83f676cd16e263f78f965bc5_MD5.jpg similarity index 100% rename from docs/Guides/Django REST Framework/_resources/1 - Setup/8d193fcb83f676cd16e263f78f965bc5_MD5.jpg rename to docs/Guides/Django REST Framework/_resources/Django REST Framework/8d193fcb83f676cd16e263f78f965bc5_MD5.jpg diff --git a/docs/Guides/Guides.md b/docs/Guides/Guides.md new file mode 100644 index 0000000..ab6fcdb --- /dev/null +++ b/docs/Guides/Guides.md @@ -0,0 +1,5 @@ +### Guide List +- [Django REST Framework Guide](Django%20REST%20Framework/1%20-%20Setup.md) +- [Service Queue -Hosted Services](Service%20Queue/Hosted%20Services.md) +- [Service Queue Relayed Services](Service%20Queue/Relayed%20Services.md) +- [SMTP Credentials](Service%20Queue/SMTP%20Credentials.md) \ No newline at end of file diff --git a/docs/Guides/Service Queue/Hosted Services.md b/docs/Guides/Service Queue/Hosted Services.md index 62ee376..b98b208 100644 --- a/docs/Guides/Service Queue/Hosted Services.md +++ b/docs/Guides/Service Queue/Hosted Services.md @@ -7,7 +7,6 @@ We however provide a network diagram on how it works under the hood for referenc ### Project Requirements We require the following for all projects - - Compatible with ARM64 architecture as our server are a fleet of Orange Pi 5s - Packaged via Docker with an included `docker-compose.yml`. Traditionally, there are two ways to do this; - Provide the source code as-is including your provided .env file. The servers will then build the image/container before being served to the public. diff --git a/docs/Guides/Service Queue/Relayed Services.md b/docs/Guides/Service Queue/Relayed Services.md index 7165125..b923c22 100644 --- a/docs/Guides/Service Queue/Relayed Services.md +++ b/docs/Guides/Service Queue/Relayed Services.md @@ -1,5 +1,4 @@ ### Overview - You can also opt to use your own servers/devices for hosting with the Service Queue project. Traffic can be relayed through a provided Wireguard VPN to direct subdomain or port traffic to your server ![Service Queue Relayed.drawio.png](_resources/Relayed%20Services/9424cf6e95838d18b4c2a4a5de25bae8_MD5.jpg) @@ -8,9 +7,7 @@ The diagram above serves as reference for the infrastructure setup with relayed Game servers can be served via the relay by forwarding the required TCP/UDP ports ### Project Requirements - The following requirements are needed for relayed projects - - A PC, laptop, or similar device - The device must be compatible with Wireguard VPN - The device must run 24/7 (or at least run continuously when required for your services to be usable) diff --git a/docs/Guides/Service Queue/Service Queue.md b/docs/Guides/Service Queue/Service Queue.md new file mode 100644 index 0000000..48de89e --- /dev/null +++ b/docs/Guides/Service Queue/Service Queue.md @@ -0,0 +1,2 @@ +### Overview +I run the \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 0b15fac..f0ebaab 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,4 @@ ### Document List -- [Django REST Framework Guide](Guides/Django%20REST%20Framework/1%20-%20Setup.md) -- [Service Queue - Hosted Services](Guides/Service%20Queue/Hosted%20Services.md) -- [Service Queue - Relayed Services](Guides/Service%20Queue/Relayed%20Services.md) -- [SMTP Credentials](Guides/Service%20Queue/SMTP%20Credentials.md) -- [Windows Apps](Files%20&%20Links/Windows%20Apps.md) -- [Bash Commands Snippets](Command%20Snippets/Bash%20Commands.md) -- [Docker - Miscellaneous Snippets](Command%20Snippets/Docker%20-%20Miscellaneous.md) -- [Docker Run Snippets](Command%20Snippets/Docker%20Run.md) \ No newline at end of file +- [Guides](Guides/Guides.md) +- [Files & Links](Files%20&%20Links/Files%20&%20Links.md) +- [Command Snippets](Command%20Snippets/Command%20Snippets.md) \ No newline at end of file diff --git a/docusaurus.config.ts b/docusaurus.config.ts index ad30203..1b515ea 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -85,6 +85,10 @@ const config: Config = { label: "Command Snippets", to: "/docs/Command Snippets", }, + { + label: "Guides", + to: "/docs/Guides", + }, ], }, {