anrey-ilin-spryker/spryker-docs

This repository is for the Spryker documentation available at https://docs.spryker.com.

Spryker documentation

This repository contains the documentation for the Spryker documentation portal.

Installation

To build the documentation site locally, see building the documentation site.

Build with Docker

To build the documentation site with Docker, run this command: docker run --rm --volume="$PWD:/srv/jekyll" --volume="$PWD/vendor/bundle:/usr/local/bundle" -p 4000:4000 jekyll/jekyll:4.2.0 jekyll serve --incremental --livereload

To contribute

1. Fork the repository.
2. In your forked repository, go to the document you want to edit. The actual documents are in the docs directory.
3. Click the pencil icon in the top right menu.
4. Once you edited the document, write a message briefly explaining what you changed and click Propose changes. This shows a diff of your changes compared to the current version of the master branch.
5. Click Create pull request.
6. To confirm the creation, click Create pull request again.
7. Set a respective label for your pull request (in progress, tech review needed, TW review needed, etc.) so we know that it's ready for review and merge.

Markup language, style, and formatting For the specific Markdown syntax we use in documentation, see Markdown syntax. For the general style, syntax, and formatting rules, see Style, syntax, formatting, and general rules.

That’s it! Your pull request has been created. Our Documentation team will review it, and once approved, your changes will be merged and available on the documentation website.

Contributors

Thank you to all our contributors!