Home Assistant Data Science Portal
This is the source for the Data Science Portal.
Updating the docs
Documentation is built using Docusaurus.
Editing on GitHub
Small changes to text can be made directly on GitHub. At the bottom of each page there is an "Edit This Page" link which will load the document in GitHub ready for changes. This method doesn't easily allow for additional documents or images to be added.
Preparing a local environment
There are two options for developing the documentation on a local system.
Visual Studio Code and devcontainer
The easiest way to get started with development is to use Visual Studio Code with devcontainers. This approach will create a preconfigured development environment with all the tools you need. This approach is enabled for all Home Assistant repositories.
- Visual Studio code
- Remote - Containers (VSC Extension)
- Fork the repository.
- Clone the repository to your computer.
- Open the repository using Visual Studio code.
When you open this repository with Visual Studio code you are asked to "Reopen in Container", this will start the build of the container.
If you don't see this notification, open the command palette and select
Remote-Containers: Reopen Folder in Container.
The devcontainter comes with some useful tasks to help you with development, you can start these tasks by opening the command palette and select
Tasks: Run Task then select the task you want to run.
When a task is currently running (like
Preview for the docs), it can be restarted by opening the command palette and selecting
Tasks: Restart Running Task, then select the task you want to restart.
When using devcontainers and starting a preview via
script/setup or the Task in Code, a browser window will not be opened automatically, instead you will need to open a browser window to localhost:3000. If port 3000 was already in use, Docusaurus will use the next available port. You can check the port used in the terminal window of Visual Studio Code. Look for the line
Project is running at http://0.0.0.0:XXXX/ where
XXXX 3000 or greater, open a browser window to
Setting Up Your Own Environment
Or in Windows, just run:
This will install docusaurus amongst other things.
Running docs locally
In Windows, just run
It will start a server at localhost:3000.
Adding a page
- Create new page in
- Add new doc to