Skip to content

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

Notifications You must be signed in to change notification settings

spryker/spryker-docs

Repository files navigation

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

Contribute

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.

To suggest changes, follow the steps:

  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. To edit the document, click the pencil icon in the top right menu.
  4. Add the needed changes.
  5. In the Commit changes pane, describe your changes and click Commit changes. This shows the updated document.
  6. To go to the main page of the repository, click Code.
  7. Next to This branch is 1 commit ahead of spryker:master., click Contribute > Open pull request.
  8. Enter a Title.
  9. For Write, enter a description of your changes.
  10. Click Create pull request.
  11. To confirm that the PR is ready to merge, set a label, like in progress, tech review needed, or TW review needed.

That’s it! Your pull request has been created. Once we review and approve the changes, they will be published on the documentation website.

Contributors

Thank you to all our contributors!