Skip to content

Commit

Permalink
docs: remove redundant build instructions from the 'Contributing' doc…
Browse files Browse the repository at this point in the history
… page
  • Loading branch information
joyenjoyer authored and HerrTopi committed Aug 17, 2023
1 parent 6ebc266 commit fca1071
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/getting-started/building-instui.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 1 addition & 11 deletions docs/getting-started/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit fca1071

Please sign in to comment.