add deploy steps for docs

This commit is contained in:
Nitwel 2024-03-17 00:50:41 +01:00
parent ae4fca328a
commit 218019d65e
9 changed files with 69 additions and 4 deletions

2
docs/.dockerignore Normal file
View File

@ -0,0 +1,2 @@
node_modules
pnpm-lock.yaml

16
docs/.drone.yml Normal file
View File

@ -0,0 +1,16 @@
---
kind: pipeline
type: docker
name: default
steps:
- name: build
image: plugins/docker
settings:
username:
from_secret: docker_username
password:
from_secret: docker_password
repo: nitwel/immersivehome-docs
tags:
- latest

1
docs/.gitignore vendored
View File

@ -1,3 +1,4 @@
reference/raw/
node_modules/
.vitepress/cache/
.vitepress/dist/

View File

@ -69,6 +69,10 @@ export default {
{
text: 'Event System',
link: '/development/event-system'
},
{
text: 'Node Functions',
link: '/development/functions'
}
]
}

19
docs/Dockerfile Normal file
View File

@ -0,0 +1,19 @@
FROM node:18-alpine AS build
WORKDIR /app
COPY package.json .
RUN npm install
COPY . .
RUN npm run generate
RUN npm run build
FROM httpd:2.4
COPY --from=build /app/.vitepress/dist /usr/local/apache2/htdocs/
EXPOSE 80

View File

@ -7,3 +7,6 @@ Full reference can be found in the [Event System](/reference/lib--globals--event
## Focus handling
By default, every Node that has the `ui_focus` group is able to receive focus. When a node receives focus, the **_on_focus_in(event: [EventFocus](/reference/EventFocus.html))** method is called. When a node loses focus, the **_on_focus_out(event: [EventFocus](/reference/EventFocus.html))** method is called.
The `ui_focus_skip` group can be added to a node to skip focus when clicking on it.
The `ui_focus_stop` group prevents focus entirely on itself and its children. Useful for the Virtual Keyboard.

View File

@ -0,0 +1,20 @@
# Node Functions
Node functions can be added to other Nodes to extend their functionality.
## Available Functions
### Clickable
Access the events that pass through the node using signals.
Useful for connection to events that happen on other nodes.
### Movable
Adds the ability to move the node using the controller or hands.
The parent needs to be a `StaticBody3D`.
### Occludable
Hides the node when it is occluded by another node like walls.

View File

@ -6,6 +6,6 @@ In order to test without a headset, press the run project (F5) button in Godot a
## With a VR Headset
To test the app with a VR headset, make sure you are able to export the project to Android. Follow the [Building](development/building.md) guide to setup the project for Android.
To test the app with a VR headset, make sure you are able to export the project to Android. Follow the [Building](/development/building) guide to setup the project for Android.
When everything is setup correctly, you can connect your Headset to your computer and press the `Export with Remote Debug` button in Godot. This will start the app on your headset and connect the Godot Editor to the app. You can now see the logs and errors in the Godot Editor while the app is running on the headset.

View File

@ -59,7 +59,7 @@ The bottom right button on the keyboard will paste the copied text into the inpu
## What's next?
You successfully connected the app to Home Assistant. Next up you have to configure the rooms, read more about it in the [Room Setup](/room-setup) section.
You successfully connected the app to Home Assistant. Next up you have to configure the rooms, read more about it in the [Room Setup](/getting-started/room-setup) section.
::: warning
Rooms have to be configured first, before you can add entities to them.