Solution Patterns: Contributor’s guide

Quickstart Guide

Run through this 15-minute section to get started quickly. If you’re looking for a detailed guide refer to the full guide.

Prerequisites

Before getting started, make sure to have the following CLI tools installed on your local machine: git, node, npm(>=12.13.0) and gulp.

1. Creating a new project

To save you some time and quickly get started documenting, we’ll use as a foundation the Solution Pattern website template.

  1. Open the template’s repository and click on the green button "Use this template" and choose Create a new repository;

    create repo button

  2. Choose the following options in Create a new repository page that is displayed:

    1. Check the Include all branches to ensure the github pages are deployed correctly.

    2. Enter your repository name (e.g. solution-pattern-xyz) and a description

    3. Choose an appropriate Owner (your personal account or one of your organizations). Once you’re ready to publish your first version, you can move or fork the repository into the redhat-solution-patterns organization.

    4. To avail of github pages to publish your documentation, keep the repository as Public.

    5. Click on "Create repository";

      create new repo page

  3. In a few seconds your repo will ready for use.

2. Building and Running the project

Next, let’s build and run the project on development mode.

  1. Clone the new repository to your local machine using git clone from your local CLI.

    You can rely on hot-reload features during your development; therefore, you’ll save time validating your implementation’s output results.

  2. In a terminal, navigate to your project’s repository;

  3. Build and start the project with:

    npm install
npx gulp

  4. A new page should open on your browser pointing to http://localhost:3000/solution-pattern-template/index.html

3. Next actions

4. Let us know when you are ready