From 17818189dea674a44952ebd7b86000daa00732b2 Mon Sep 17 00:00:00 2001 From: Tom Brien Date: Sun, 9 May 2021 00:18:20 +0100 Subject: [PATCH] Add docs getting started to top menu (#926) --- docs/documenting.md | 25 ++++++++++++++++++++----- docusaurus.config.js | 3 ++- 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/documenting.md b/docs/documenting.md index d401bad4..28aa16bb 100644 --- a/docs/documenting.md +++ b/docs/documenting.md @@ -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: diff --git a/docusaurus.config.js b/docusaurus.config.js index 1bed0be3..5c9e44e8 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -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",