Contribute content

Thank you for your interest in contributing to the platformOS documentation! Our docs are a tool for our community, so we strive to ensure they serve you well. We always welcome any kind of contribution to our documentation: we value your feedback, and appreciate any improvement suggestions or extensions.

Give us feedback

Create an issue with your finding.

Edit or add topics on the GitHub UI

Go to the file you would like to change, click edit and commit changes on the GitHub UI.

Edit or add topics using git

1. Fork the repository.
2. Install dependencies (NPM).
3. Change something or add a new topic. Please check if a template is already available for the type of content you’d like to contribute. We have prepared templates for most content on our documentation page, to make contribution easier, and to ensure the consistency of contributed content. Please make sure to follow our style guide.
4. Create a pull request.
5. We review your changes, and either get back to you with our feedback, or merge your changes.

Contributors

Thank you to all our contributors!

pavelloz	diana-lakatos	piotrze	Slashek	lemingos	ignacy

godot	szabosteve	kv109	chrisdanek	onecreative	DeanmvSG

digitalfuel	kubaugustyn	turing9783	JJBragg	juliennearme	streflik

power833	mjaneczek	kbd332	Agsiegert	Developer-DNM

Contribute code

Required global dependencies

• nodejs 8.10 and above
• npm 6.1 and above

Development

npm ci # installs local dependencies

npm start # runs webpack in watch mode

Build production assets

npm run build # runs webpack in production mode

End to end local testing

We are using testcafe to run E2E tests

npm install -g testcafe

npm run test-local # uses headless chrome. use `npm run` for details