From fca107181d272ca7341108d89669537c797ae7df Mon Sep 17 00:00:00 2001 From: Peter Pal Hudak Date: Wed, 16 Aug 2023 09:01:11 +0200 Subject: [PATCH] docs: remove redundant build instructions from the 'Contributing' doc page --- docs/getting-started/building-instui.md | 2 +- docs/getting-started/contributing.md | 12 +----------- 2 files changed, 2 insertions(+), 12 deletions(-) diff --git a/docs/getting-started/building-instui.md b/docs/getting-started/building-instui.md index 2f91a00d51..67ba1c9189 100644 --- a/docs/getting-started/building-instui.md +++ b/docs/getting-started/building-instui.md @@ -10,7 +10,7 @@ Instructure UI is a mono-repository which means it has multiple packages (almost The project uses `yarn` for managing these packages and also for resolving dependencies, running scripts and managing the whole mono-repository itself. -> **Note**: Windows OS is not supported as a build platform due to some libraries that we rely on for building Instructure UI do not support Windows +> **Note**: Windows is only partially supported. One can build the project and documentation apps, running other commands (like testing) fail. > > Also we're using environment variables through our build pipeline and they are defined differently in Linux/OSX and Windows. diff --git a/docs/getting-started/contributing.md b/docs/getting-started/contributing.md index 2169339a83..7ec6fa1e30 100644 --- a/docs/getting-started/contributing.md +++ b/docs/getting-started/contributing.md @@ -23,17 +23,7 @@ constructed from the existing ones. For these reasons adding a new component has ### Building InstUI from the source -Follow these steps to download and compile Instructure UI on your machine: - -1. Install [Git](http://git-scm.com/). -1. Install [Node >= 12.20](https://nodejs.org/en/)) (we recommend [nvm](https://github.com/creationix/nvm) to manage multiple Node versions). -1. Install [Yarn >=1.6](https://yarnpkg.com/lang/en/docs/install/) -1. Clone the repository with `git clone` (If you want to make changes clone the forked repo in your account.) -1. Run `cd instructure-ui` -1. Run `yarn` -1. Run `yarn bootstrap` - -Run `yarn run` to list the available commands. +Please follow the steps on the [how to build guide page](#building-instui). ### Running the documentation app