jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-18 23:06:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs getting started to top menu (#926)

Browse Source
This commit is contained in:
Tom Brien 2021-05-09 00:18:20 +01:00 committed by GitHub
parent 2d539aa371
commit 17818189de
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/documenting.md
View File

@ -15,14 +15,29 @@ For larger changes, we suggest that you clone the website repository. This way,
To test your changes locally, you need to install **Ruby** and its dependencies (gems):
- [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/) if you don't have it already. Ruby version 2.5.0 or higher is required. Ruby version 3 is not supported yet.
- Install `bundler`, a dependency manager for Ruby: `$ gem install bundler` (You might have to run this command as `sudo`).
- Install `bundler`, a dependency manager for Ruby: `gem install bundler` (You might have to run this command as `sudo`).
- Shortcut for Fedora:
```shell
sudo dnf -y install gcc-c++ ruby ruby-devel rubygem-bundler rubygem-json && bundle
```
- Shortcut for Debian/Ubuntu:
```shell
sudo apt-get install ruby ruby-dev ruby-bundler ruby-json g++ zlib1g-dev && bundle
```
- Shortcut for Mac (if the bundled Ruby doesn't work):
```shell
brew install ruby@2.7 && export PATH="/usr/local/opt/ruby@2.7/bin:$PATH"
```
- Shortcut for Fedora: `$ sudo dnf -y install gcc-c++ ruby ruby-devel rubygem-bundler rubygem-json && bundle`
- Shortcut for Debian/Ubuntu: `$ sudo apt-get install ruby ruby-dev ruby-bundler ruby-json g++ zlib1g-dev && bundle`
- Shortcut for Mac (if the bundled Ruby doesn't work): `brew install ruby@2.7 && export PATH="/usr/local/opt/ruby@2.7/bin:$PATH"`
- Fork the home-assistant.io [git repository](https://github.com/home-assistant/home-assistant.io).
- In your home-assistant.io root directory, run `$ bundle` to install the gems you need.
- In your home-assistant.io root directory, run `bundle` to install the gems you need.
Then you can work on the documentation:

3
docusaurus.config.js
View File

@ -41,8 +41,9 @@ module.exports = {
label: "Documenting",
position: "left",
items: [
{ label: "Getting Started", to: "docs/documenting" },
{ label: "Standards", to: "docs/documenting/standards" },
{ label: "YAML Style Guide", to: "docs/documenting/yaml-style-guide"},
{ label: "YAML Style Guide", to: "docs/documenting/yaml-style-guide" },
{
label: "Create a new page",
to: "docs/documenting/create-page",