react-markdown-panel v1.0.1

Setting up your component

Delete this section after you've setup the component

Before the component is accepted into the DLS:

1. Github: Create the repository under your own username/organisation

When the component is accepted into the DLS:

1. Github: Transfer ownership of the repository to frontend
2. BuildKite: Create a New Pipeline
3. BuildKite: Enter the following settings:

• Name: markdown-panel
• Git Repository: git@git.nib.com.au:frontend/markdown-panel.git

4. BuildKite: Remove the default Step and add a Read steps from repository step

• And add cd deploy && bundle install && bundle update sceptre sceptre-dotnet sceptre-app && bundle exec sceptre-app pipeline upload to the Commands to run textbox
• And add os=linux to the Agent Targeting Rules textbox

5. BuildKite: Create Pipeline and follow the instructions to add the webhook to GithubEnterprise
6. BuildKite: Go to Settings

• Check Build pull requests from third-party forked repositories and click Save Github Enterprise Settings
• Copy the Markdown badge from Settings and past it below.

7. Github: Edit the readme to remove these steps and kick off a New build
8. Github: Protect the master branch

• Go to Settings > Branches
• Choose the master branch
• Check Protect this branch
• Check Require status checks to pass before merging
• Check Include administrators and Require branches to be up to date before merging
• Check all Status checks found in the last week for this repository

@nib-components/markdown-panel

A markdown-panel component.

Installation

npm install --save react-markdown-panel

Usage

import MarkdownPanel from 'react-markdown-panel';

<MarkdownPanel/>

<MarkdownPanel/>

Properties

requiredProp

{Some prop description}

Required. An array.

optionalProp

{Some optional prop description}

Optional. A string. Defaults to 'hello world'.

Change log

1.0.0

Initial release.

Contributing

You can edit the files in ./src, whilst running npm run watch. This will compile for the ./dist folder.